Sync release docs with recent changelog automation changes#2634
Sync release docs with recent changelog automation changes#2634
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
WalkthroughUpdated release/changelog docs: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Review: Documentation accuracy — LGTM with one minor noteThe changes correctly sync
One small inaccuracy flagged inline (auto-compute bullet does not apply when an explicit version is supplied). Potential follow-up (pre-existing, out of scope for this PR): |
Greptile SummaryThis documentation-only PR syncs Key changes:
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant CC as Claude Code<br/>/update-changelog
participant Rake as update_changelog.rake
participant GH as GitHub
Dev->>CC: /update-changelog release<br/>(or rc / beta / explicit version)
CC->>Rake: bundle exec rake update_changelog[mode]
Note over Rake: git tags → latest stable version<br/>changelog headings → bump type<br/>git tags only → prerelease index
Rake-->>CC: CHANGELOG.md stamped with version header<br/>+ v-prefixed compare links updated
CC->>CC: Verify working tree clean<br/>Verify branch is main
CC->>GH: git push (new branch changelog-X.Y.Z)
CC->>GH: gh pr create (changelog diff as body)
GH-->>Dev: PR opened for review
Dev->>GH: Review + merge changelog PR
Dev->>Dev: bundle exec rake release
Note over Dev: rake release reads version from CHANGELOG.md<br/>auto-creates GitHub release
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d78c9db215
ℹ️ 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".
d78c9db to
9bb2029
Compare
Review: Sync release docs with recent changelog automation changesThis is a clean, accurate documentation sync. The changes to One remaining inconsistency
**Before a release** -- Stamp a version header and prepare for release:
- Run `/update-changelog release` (or `rc` or `beta`) to add entries AND stamp the version header
- The version is auto-computed from changelog content (see "Auto-Computing the Next Version" below)
- Commit and push CHANGELOG.md ← stale: auto-PR now
- Then run `rake release` (no args needed ...) ← stale: needs PR merge firstStep 5 of the same file (lines 325–332) already documents the correct auto-commit/push/PR behavior, so this summary block is contradicting the actual instructions. Suggested update: **Before a release** -- Stamp a version header and prepare for release:
- Run `/update-changelog release` (or `rc`, `beta`, or an explicit version like `16.5.0.rc.10`) to add entries AND stamp the version header
- The version is auto-computed from changes (breaking → major, features → minor, fixes → patch)
- The command automatically commits, pushes, and opens a PR — review and merge it
- Then run `rake release` (no args needed -- it reads the version from CHANGELOG.md)
- The release task automatically creates a GitHub release from the changelog sectionThis isn't a blocker for merging — the detailed Step 5 instructions are authoritative — but it would prevent the summary block from misleading contributors. Otherwise LGTMAll three documentation sites ( |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9bb2029950
ℹ️ 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".
Review: Documentation-only sync, correct but partially incompleteThe changes to
One gap in
|
|
Addressed the stale "Before a release" summary block in
This addresses the feedback from @claude[bot] and @greptile-apps[bot] about the stale manual workflow instructions contradicting Step 5's auto-PR behavior. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 27c288abed
ℹ️ 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".
|
Clean documentation sync. A few notes: (1) Remaining stale master references: This PR fixes line 327 but lines 209, 223, 232-233, 260, 267-269 of update-changelog.md still reference master/origin/master. The repo default branch is main — worth a follow-up. (2) Minor: The Version Stamping section header (line 153) only lists release/rc/beta but not explicit versions, though Step 4 documents them correctly. (3) The actual changes look correct: the git-tags-only description, the explicit-version Option A example in releasing.md, and the v-prefix note for compare links are all accurate. |
- releasing.md: Update step 1 to reflect that /update-changelog now supports explicit versions, collapses prereleases with dedup, and auto-commits/pushes/opens a PR (no more manual commit/push step) - releasing.md: Add note about v prefix requirement in compare links - releasing.md: Update Option A post-release instructions to match new auto-PR behavior - update-changelog.md: Fix stale description saying version is computed from "changelog headings and git tags" - prerelease index is now determined solely from git tags per recent fix Co-Authored-By: Claude Opus 4.6 <[email protected]>
When an explicit version like 16.5.0.rc.10 is provided, auto-computation is skipped. The bullet list previously implied auto-compute applies to all modes including explicit versions. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
- releasing.md: Use explicit version in post-release catch-up example instead of misleading `release` mode that computes the next version - update-changelog.md: Fix branch check from `master` to `main` to match the repo's actual default branch - update-changelog.md: Update stale "Before a release" summary to reflect auto-commit/push/PR behavior and explicit version support Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
…docs - Replace all remaining `master`/`origin/master` references with `main`/`origin/main` in update-changelog.md (lines 209, 223, 232-233, 260, 267-269) - Add `git pull --rebase` step in releasing.md Option A before sync_github_release, since the auto-PR is merged on GitHub and local checkout needs updating first Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
27c288a to
a48394a
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a48394ab3d
ℹ️ 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".
| 3. Review the changelog entries and verify the computed version | ||
| 4. Commit and push CHANGELOG.md | ||
| - For `rc`/`beta`: collapse prior prerelease sections and deduplicate entries | ||
| - **Automatically commit, push, and open a PR** with the changelog changes |
There was a problem hiding this comment.
Require a local
main checkout for the auto-PR flow
This step now promises that /update-changelog … will automatically commit, push, and open a PR, but the slash command aborts unless git branch --show-current is main (.claude/commands/update-changelog.md:325-329). Having the changes merely merged to main is not enough; if a releaser runs this from any other local branch, the automation stops before the PR is created, so the documented release-prep flow fails.
Useful? React with 👍 / 👎.
| The rake task handles: | ||
|
|
||
| - Auto-computing the next version from changelog headings and git tags | ||
| - Auto-computing the next version from git tags (prerelease index is determined solely from tags, not changelog headers) |
There was a problem hiding this comment.
Don't describe version auto-computation as tag-only
This bullet now overcorrects the prerelease-index note. compute_auto_version still calls inferred_bump_type_from_unreleased to decide the major/minor/patch bump from the ### [Unreleased] headings, and only uses git tags for the latest stable version and prerelease index (react_on_rails/rakelib/update_changelog.rake:399-414). Saying the rake task computes the next version “from git tags” can mislead releasers about why a release bump changed when they edit changelog headings.
Useful? React with 👍 / 👎.
Review: Sync release docs with recent changelog automation changesThis is a clean documentation-only PR. The changes accurately reflect the current automation behavior. What's done well
Minor gap: missing branch-switch step after merging the auto-PRThe new auto-PR flow in
After the auto-PR is merged on GitHub, the user is still on the local git checkout main
git pull --rebase
bundle exec rake releaseThe same implicit gap exists in
This is the only substantive issue; everything else looks correct and well-aligned with the actual automation behavior. |
| - Run `/update-changelog release` (or `rc`, `beta`, or an explicit version like `16.5.0.rc.10`) to add entries AND stamp the version header | ||
| - The version is auto-computed from changes (breaking -> major, features -> minor, fixes -> patch) — skipped when an explicit version is provided | ||
| - The command automatically commits, pushes, and opens a PR — review and merge it | ||
| - Then run `rake release` (no args needed -- it reads the version from CHANGELOG.md) |
There was a problem hiding this comment.
After merging the auto-PR, the user is still on the local changelog-X.Y.Z branch. Suggest adding a step here:
| - Then run `rake release` (no args needed -- it reads the version from CHANGELOG.md) | |
| - Checkout `main`, pull the merged changes (`git checkout main && git pull --rebase`), then run `rake release` (no args needed -- it reads the version from CHANGELOG.md) |
Or as two separate bullets for clarity:
- After the PR merges: `git checkout main && git pull --rebase`
- Then run `rake release` (no args needed -- it reads the version from CHANGELOG.md)
| 4. Commit and push CHANGELOG.md | ||
| - For `rc`/`beta`: collapse prior prerelease sections and deduplicate entries | ||
| - **Automatically commit, push, and open a PR** with the changelog changes | ||
| 3. Review the PR, verify the computed version, and merge |
There was a problem hiding this comment.
Same gap here: after merging the changelog PR, the user is on the changelog-X.Y.Z feature branch locally. Step 2 (rake release) needs a preceding checkout+pull. Suggest:
| 3. Review the PR, verify the computed version, and merge | |
| 3. Review the PR, verify the computed version, and merge; then `git checkout main && git pull --rebase` |
## Summary - Stamp `### [16.5.0.rc.0]` version header with today's date - Add 10 new changelog entries for PRs merged since v16.4.0 - Fix incomplete PR 2818 entry (missing author link) ### New entries added **Added:** - `create-react-on-rails-app --pro` support (PR 2818) - Global prerender env override `REACT_ON_RAILS_PRERENDER_OVERRIDE` (PR 2816) - `react_on_rails:sync_versions` rake task (PR 2797) - Pro/RSC setup checks in `react_on_rails:doctor` (PR 2674) **Changed:** - [Pro] Canonical env var for worker count is now `RENDERER_WORKERS_COUNT` (PR 2611) **Improved:** - Smoother `create-react-on-rails-app` and install generator flows (PR 2650) - Pro upgrade hint after install (PR 2642) **Fixed:** - Preserve runtime env vars across `Bundler.with_unbundled_env` (PR 2836) - Fix doctor prerender check and ExecJS display for Pro/RSC apps (PR 2773) - Fix doctor false positives for custom layouts (PR 2612) ### Skipped PRs (not user-visible) Docs-only: #2845, #2842, #2826, #2830, #2820, #2809, #2803, #2785, #2801, #2791, #2789, #2788, #2772, #2778, #2780, #2784, #2671, #2676, #2662, #2657, #2669 CI/internal tooling: #2825, #2817, #2819, #2812, #2815, #2810, #2808, #2807, #2634, #2798, #2761, #2760, #2658, #2639, #2667, #2656 ## Test plan - [x] Verified version header and diff links are correct - [x] Verified all entries follow changelog formatting conventions - [x] Verified file ends with newline - [ ] After merge, run `rake release` to publish 16.5.0.rc.0 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only change updating `CHANGELOG.md` with a new `16.5.0.rc.0` section and compare links; no runtime code is modified. > > **Overview** > Adds a new `16.5.0.rc.0` (2026-03-25) section to `CHANGELOG.md`, consolidating recent PR entries under **Added/Changed/Improved/Fixed** and correcting the previously incomplete `--pro` CLI entry author attribution. > > Updates the bottom compare links so `[unreleased]` now compares from `v16.5.0.rc.0` and adds a link definition for `[16.5.0.rc.0]`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 481a71c. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Release Notes - v16.5.0.rc.0 * **New Features** * Added sync_versions task for streamlined version management * Expanded doctor checks for Pro and RSC support * **Improvements** * Enhanced generator workflow and Pro upgrade guidance * Improved environment variable handling and preservation * **Bug Fixes** * Fixed detection issues with doctor tools and ExecJS/prerender functionality <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
## Summary Recent commits (15f6cfc, 078a8b0, 97f4625) updated `update_changelog.rake` and `update-changelog.md` with significant improvements (orphaned prerelease link cleanup, v prefix fix for compare links, consolidate/deduplicate blocks, explicit version support, auto-commit/push/PR). However `releasing.md` was not updated to match, leaving stale instructions. - **releasing.md**: Update step 1 to reflect `/update-changelog` now supports explicit versions, collapses prereleases with dedup, and auto-commits/pushes/opens a PR (removes manual "commit and push CHANGELOG.md" step) - **releasing.md**: Add note about `v` prefix requirement in CHANGELOG compare links (per #2628 fix) - **releasing.md**: Update Option A post-release instructions to match new auto-PR behavior - **update-changelog.md**: Fix stale description saying version computed from "changelog headings and git tags" -- prerelease index is now determined solely from git tags No changes to `release.rake` -- it was not affected by the recent changes. ## Test plan - [ ] Verify `releasing.md` step 1 accurately describes current `/update-changelog` behavior - [ ] Verify compare link `v` prefix note matches actual `update_changelog_links()` behavior - [ ] Verify `update-changelog.md` description matches `compute_auto_version()` logic 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only updates that align release/changelog instructions with current automation behavior; no runtime code paths or release tooling logic changed. > > **Overview** > Aligns release and changelog docs with the updated `/update-changelog` automation: explicit version support, skipping auto-versioning when provided, prerelease section collapse/dedup, and auto commit/push/PR creation. > > Clarifies versioning/link rules (prerelease index derived from git tags only; CHANGELOG compare links must use `v`-prefixed tags), updates instructions from `master` to `main`, and refreshes post-release catch-up steps to use the new auto-PR flow. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit a48394a. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added support for explicit prerelease/versions (e.g., 16.5.0.rc.10); auto-version computation is skipped when explicit version provided * Clarified prerelease changelog handling: collapse prior prerelease sections, deduplicate entries, and derive prerelease index from git tags * Documented automated workflow: command can automatically commit, push, and open a PR (now requires working on main) * Require changelog compare links to use v-prefixed tag names and compare against main <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 <[email protected]>
## Summary Recent commits (15f6cfc, 078a8b0, 97f4625) updated `update_changelog.rake` and `update-changelog.md` with significant improvements (orphaned prerelease link cleanup, v prefix fix for compare links, consolidate/deduplicate blocks, explicit version support, auto-commit/push/PR). However `releasing.md` was not updated to match, leaving stale instructions. - **releasing.md**: Update step 1 to reflect `/update-changelog` now supports explicit versions, collapses prereleases with dedup, and auto-commits/pushes/opens a PR (removes manual "commit and push CHANGELOG.md" step) - **releasing.md**: Add note about `v` prefix requirement in CHANGELOG compare links (per #2628 fix) - **releasing.md**: Update Option A post-release instructions to match new auto-PR behavior - **update-changelog.md**: Fix stale description saying version computed from "changelog headings and git tags" -- prerelease index is now determined solely from git tags No changes to `release.rake` -- it was not affected by the recent changes. ## Test plan - [ ] Verify `releasing.md` step 1 accurately describes current `/update-changelog` behavior - [ ] Verify compare link `v` prefix note matches actual `update_changelog_links()` behavior - [ ] Verify `update-changelog.md` description matches `compute_auto_version()` logic 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only updates that align release/changelog instructions with current automation behavior; no runtime code paths or release tooling logic changed. > > **Overview** > Aligns release and changelog docs with the updated `/update-changelog` automation: explicit version support, skipping auto-versioning when provided, prerelease section collapse/dedup, and auto commit/push/PR creation. > > Clarifies versioning/link rules (prerelease index derived from git tags only; CHANGELOG compare links must use `v`-prefixed tags), updates instructions from `master` to `main`, and refreshes post-release catch-up steps to use the new auto-PR flow. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit a48394a. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added support for explicit prerelease/versions (e.g., 16.5.0.rc.10); auto-version computation is skipped when explicit version provided * Clarified prerelease changelog handling: collapse prior prerelease sections, deduplicate entries, and derive prerelease index from git tags * Documented automated workflow: command can automatically commit, push, and open a PR (now requires working on main) * Require changelog compare links to use v-prefixed tag names and compare against main <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 <[email protected]>
Summary
Recent commits (15f6cfc, 078a8b0, 97f4625) updated
update_changelog.rakeandupdate-changelog.mdwith significant improvements (orphaned prerelease link cleanup, v prefix fix for compare links, consolidate/deduplicate blocks, explicit version support, auto-commit/push/PR). Howeverreleasing.mdwas not updated to match, leaving stale instructions./update-changelognow supports explicit versions, collapses prereleases with dedup, and auto-commits/pushes/opens a PR (removes manual "commit and push CHANGELOG.md" step)vprefix requirement in CHANGELOG compare links (per Fix missing v prefix in changelog compare links #2628 fix)No changes to
release.rake-- it was not affected by the recent changes.Test plan
releasing.mdstep 1 accurately describes current/update-changelogbehaviorvprefix note matches actualupdate_changelog_links()behaviorupdate-changelog.mddescription matchescompute_auto_version()logic🤖 Generated with Claude Code
Note
Low Risk
Documentation-only updates that align release/changelog instructions with current automation behavior; no runtime code paths or release tooling logic changed.
Overview
Aligns release and changelog docs with the updated
/update-changelogautomation: explicit version support, skipping auto-versioning when provided, prerelease section collapse/dedup, and auto commit/push/PR creation.Clarifies versioning/link rules (prerelease index derived from git tags only; CHANGELOG compare links must use
v-prefixed tags), updates instructions frommastertomain, and refreshes post-release catch-up steps to use the new auto-PR flow.Written by Cursor Bugbot for commit a48394a. This will update automatically on new commits. Configure here.
Summary by CodeRabbit