docs: update README for v2.7.0 - #272
Conversation
- Bump dependency coordinate examples in README from 2.6.3 to 2.7.0. - Add the Crash tab to the Debug Panel list and a short "Crash logs" usage section covering the new crash log persistence (#231). - Drop the "Logcat buffer size" paragraph about `logcat -T N` / `-t N`: the one-shot capture is gone, the reader no longer starts on panel open, and the replayed history is no longer tied to maxLogcatEntries. - Add CHANGELOG entry for v2.7.0 covering crash log persistence (#271), the switch to streaming logcat from app start, and AGP 9.3.1 (#241). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Claude finished @Manabu-GT's task in 2m 43s —— View job Review: docs update for v2.7.0
Verdict: accurate and ready to merge. I checked every factual claim against the code rather than taking the PR description at its word, and they all hold. Findings below are optional polish, not blockers. What I verified
The removed
|
|
Warning Review limit reached
Next review available in: 28 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR documents Version 2.7.0, including persisted crash logs, the Crash tab, Logcat behavior, updated dependency examples, and AGP 9.3.1 release notes. ChangesRelease documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1e5adcfb0d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 208-210: Update the crash-reporting descriptions to distinguish
persistence from network capture: in README.md lines 208-210, state that crash
persistence needs no setup while network activity requires the OkHttp extension
or another configured source; apply the same qualification to the Crash tab
description in README.md line 56 and the release note in CHANGELOG.md line 7.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: da315e64-8359-46b2-a5f4-b46a861d0ff4
📒 Files selected for processing (2)
CHANGELOG.mdREADME.md
| No setup required. Crashes are saved to disk and shown in the **Crash** tab on the next launch, | ||
| with the stack trace and the logs/network activity leading up to them. Copy, share or delete each; | ||
| the 5 most recent are kept. Your existing crash reporter is unaffected. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Qualify network capture as optional.
DebugOverlay defaults to NoOpNetworkRequestSource. Network activity requires a configured source, such as the OkHttp extension.
README.md#L208-L210: State that crash persistence needs no setup, but network activity requires the OkHttp extension or another configured source.README.md#L56-L56: Qualify the Crash tab description with the same condition.CHANGELOG.md#L7-L7: Add the same condition to the release note.
📍 Affects 2 files
README.md#L208-L210(this comment)README.md#L56-L56CHANGELOG.md#L7-L7
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 208 - 210, Update the crash-reporting descriptions to
distinguish persistence from network capture: in README.md lines 208-210, state
that crash persistence needs no setup while network activity requires the OkHttp
extension or another configured source; apply the same qualification to the
Crash tab description in README.md line 56 and the release note in CHANGELOG.md
line 7.
Qodana for JVMIt seems all right 👌 No new problems were found according to the checks applied 💡 Qodana analysis was run in the pull request mode: only the changed files were checked Contact Qodana teamContact us at qodana-support@jetbrains.com
|
Review feedback on #272: - Crash records trim each source to the last 100 entries (CrashRecordBuilder.DEFAULT_MAX_LOG_LINES), independent of maxLogcatEntries. The section directly above tells readers to raise that to 1000, so state the cap rather than let the adjacency imply it applies. - Network activity needs a configured NetworkRequestSource; the default is NoOpNetworkRequestSource, so a bare install captures none. Matches how the Network tab entry already links to its setup section. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sits beside the debug panel gif, mirroring the bug report section's gif + png pairing. Both are pinned to width=256 so they render on one line: the gif is 256px wide natively while the screenshot is 1080px, which would otherwise fill the row and push the gif below it. Their aspect ratios match (0.4499 vs 0.4500), so equal widths give equal heights. Screenshot downscaled to 540px and run through pngquant (272KB -> 57KB); it still opens larger than it renders, so the stack trace stays readable. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Consecutive <img> lines don't sit next to each other: GitHub's renderer wraps each one in its own <p>, so they stack as separate blocks. Verified via the /markdown API. Wrapping both in a single <p> puts them in one block, where they flow inline. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Release prep for v2.7.0, following #271.
README
maxLogcatEntries"bounds thelogcat -T N/-t Ncalls … when the panel opens and when a bug report snapshot is captured". All three parts are false as of feat: add crash log persistence and its ui tab #271: the one-shot-t Ncapture was removed, the reader now starts with the process rather than on panel open, and the replayed history is a fixed amount independent of this value.CHANGELOG — v2.7.0:
maxLogcatEntriesgoverns buffer retention only. Both are behavior changes worth flagging for anyone who set that value.Note: bug reports already included logs without the panel being opened (via the old one-shot capture fallback), so the changelog attributes that gain to crash records only.
Docs only; no build or test run required.
🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
maxLogcatEntriesbehavior to retain the configured number of entries.Documentation