Skip to content

Sync release docs with recent changelog automation changes#2634

Merged
justin808 merged 4 commits intomainfrom
jg/release-docs-sync-recent-changes
Mar 23, 2026
Merged

Sync release docs with recent changelog automation changes#2634
justin808 merged 4 commits intomainfrom
jg/release-docs-sync-recent-changes

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 16, 2026

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 Fix missing v prefix in changelog compare links #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


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.

Written by Cursor Bugbot for commit a48394a. This will update automatically on new commits. Configure here.

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 16, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 072f5b31-6bf7-46a1-89e6-0a2f325a1131

📥 Commits

Reviewing files that changed from the base of the PR and between 27c288a and a48394a.

📒 Files selected for processing (2)
  • .claude/commands/update-changelog.md
  • internal/contributor-info/releasing.md
✅ Files skipped from review due to trivial changes (1)
  • .claude/commands/update-changelog.md

Walkthrough

Updated release/changelog docs: /update-changelog accepts rc/beta and explicit versions (skips auto-version when explicit); prerelease index for beta/rc comes from git tags only; prerelease sections are collapsed/deduped; the task now auto-commits, pushes, and opens a PR; branch checks and compare links use main and v-prefixed tags.

Changes

Cohort / File(s) Summary
Changelog command guidance
\.claude/commands/update-changelog.md
Documented explicit version support (e.g., 16.5.0.rc.10), skipping auto-computation when explicit, prerelease handling changes, automatic commit/push/PR behavior, and branch/compare-link examples updated from mastermain and requiring v-prefixed tags.
Release process docs
internal/contributor-info/releasing.md
Expanded /update-changelog release args to accept rc/beta and explicit versions; clarified prerelease index derivation (git tags only), collapsing/deduping prior prereleases; changed workflow to auto-commit/push/open PR then review/merge; updated git commands and compare links to reference main and v-prefixed tags.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hop through tags and count each one,
I fold old betas till the churn is done,
I commit, push, open a PR with glee,
Merge it in and tidy history,
A rabbit’s changelog, neat as can be.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main objective of the PR: syncing release documentation with recent changelog automation updates. It directly reflects the primary changes to releasing.md and update-changelog.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg/release-docs-sync-recent-changes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread internal/contributor-info/releasing.md
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 16, 2026

Review: Documentation accuracy — LGTM with one minor note

The changes correctly sync releasing.md with the actual current behavior of the /update-changelog automation. Spot-checked against the rake task (update_changelog.rake) and the slash command (.claude/commands/update-changelog.md):

  • update-changelog.md fix (line 163): Accurate — compute_auto_version calls prerelease_indices_from_tags only; changelog headers are never consulted for the prerelease index.
  • Explicit version support: Correctly documented; the rake task handles non-keyword inputs via normalize_version_string.
  • Auto collapse + dedup: Accurate — collapse_prerelease_series + consolidate_changelog_blocks/deduplicate_block_entries confirm this.
  • Auto-commit/push/PR: Correct — Step 5 of the slash command spec documents this as the expected behavior for versioned invocations.
  • v prefix on compare links: Accurate — update_changelog_links in the rake task always emits v<version> in the generated URLs.

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): .claude/commands/update-changelog.md line 29 still reads "Commit and push CHANGELOG.md" as a manual step in the "Before a release" section, which contradicts the auto-commit/push/PR behavior documented in its own Step 5. Worth a follow-up pass to remove that stale instruction.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Mar 16, 2026

Greptile Summary

This documentation-only PR syncs releasing.md and .claude/commands/update-changelog.md with three recent automation improvements to update_changelog.rake: explicit version support, prerelease section collapse/deduplication, and auto-commit/push/PR. It also adds the v-prefix requirement for CHANGELOG compare links and corrects the branch name in the auto-commit guard from master to main.

Key changes:

  • releasing.md step 1 now lists all argument forms (release, rc, beta, explicit version), documents the auto-PR flow, and removes the now-obsolete manual "commit and push" step
  • New note in releasing.md § 4 ("Version Format") documents the v-prefix requirement for compare links — consistent with update_changelog_links in the rake task
  • releasing.md Option A post-release catch-up correctly switches to /update-changelog 16.5.0 (explicit version, which triggers auto-PR) followed by sync_github_release
  • update-changelog.md rake-task summary bullet corrected: prerelease index is determined solely from git tags, not changelog headers (confirmed in compute_auto_version)
  • update-changelog.md step 5 branch guard updated from master to main (the repo default branch)
  • Minor pre-existing inconsistency: several other master references in update-changelog.md process steps (lines 232–233, 268) and the example link on line 209 were not updated in this pass

Confidence Score: 5/5

  • Documentation-only PR with accurate changes verified against the rake task source; safe to merge.
  • All documented behaviors were cross-checked against update_changelog.rake: the git-tags-only prerelease index (compute_auto_version), the v-prefix compare link generation (update_changelog_links), the main branch reference (cleanup_collapsed_prerelease_links), and the auto-commit/push flow (step 5 instructions). The sole issue is a handful of pre-existing master references in process-step prose that this PR didn't sweep — low-priority cleanup for a follow-up.
  • No files require special attention; the pre-existing master references in update-changelog.md lines 232–233 and 268 are worth a follow-up cleanup but do not block merge.

Important Files Changed

Filename Overview
.claude/commands/update-changelog.md Updated three bullet points: explicit version support added to "Before a release" use-case; auto-commit/push/PR behavior replaces manual commit step; rake task description now correctly states prerelease index is derived solely from git tags (not changelog headers); mastermain branch name fixed in step 5 auto-commit guard. A few pre-existing master references in the process section (lines 232–233, 268, 209) were not updated in this pass.
internal/contributor-info/releasing.md Step 1 of the release process now accurately reflects: explicit version support, auto-skip of version computation, rc/beta prerelease collapsing/deduplication, and the auto-commit/push/PR flow. New note on CHANGELOG.md compare links requiring the v prefix is correct (matches update_changelog_links in the rake task). Option A post-release catch-up correctly uses /update-changelog 16.5.0 (explicit version) with a note to sync the GitHub release after merge. Changes are accurate and complete.

Sequence Diagram

sequenceDiagram
    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
Loading

Comments Outside Diff (1)

  1. .claude/commands/update-changelog.md, line 232-233 (link)

    Stale master references not updated alongside line 327 fix

    This PR correctly updates line 327 from mastermain (the branch check before auto-committing), but the following lines in the same file still reference master and will cause Claude to run incorrect git commands:

    • Line 232: git fetch origin master — should be git fetch origin main
    • Line 233: origin/master (used for all comparisons) — should be origin/main
    • Line 268: git log --oneline LATEST_TAG..origin/master — should be origin/main

    The update_changelog_links rake helper also confirms the repo uses main:

    new_unreleased_link = "#{compare_link_prefix}/v#{version}...main"

    Additionally, the example link on line 209 (...master) would be inconsistent with the generated output:

    [unreleased]: https://github.com/shakacode/react_on_rails/compare/v16.2.0.beta.19...master
    

    should read ...main.

    These are pre-existing issues, but since this PR explicitly patches the mastermain inconsistency in step 5, it would be clean to fix the remaining occurrences in the same pass.

Reviews (2): Last reviewed commit: "Address review feedback on release docs ..." | Re-trigger Greptile

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread internal/contributor-info/releasing.md Outdated
@justin808 justin808 force-pushed the jg/release-docs-sync-recent-changes branch from d78c9db to 9bb2029 Compare March 22, 2026 01:41
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 22, 2026

Review: Sync release docs with recent changelog automation changes

This is a clean, accurate documentation sync. The changes to releasing.md correctly reflect the current behavior: explicit version support, rc/beta collapsing/deduplication, and the auto-commit/push/PR flow replacing the old manual step. The update-changelog.md fix for the rake task description is also accurate.

One remaining inconsistency

update-changelog.md has a "Before a release" summary block (lines 26–30) that still describes the old manual workflow and was not updated by this PR:

**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 first

Step 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 section

This isn't a blocker for merging — the detailed Step 5 instructions are authoritative — but it would prevent the summary block from misleading contributors.

Otherwise LGTM

All three documentation sites (releasing.md steps, the v-prefix requirement note, and the rake task bullet in update-changelog.md) are now accurate and internally consistent with the actual rake task and Step 5 behavior. The PR achieves its stated goal.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread internal/contributor-info/releasing.md
Comment thread internal/contributor-info/releasing.md
Comment thread .claude/commands/update-changelog.md
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 22, 2026

Review: Documentation-only sync, correct but partially incomplete

The changes to releasing.md are accurate and well-aligned with the current automation:

  • Explicit version support documented correctly
  • Auto-compute-skipped-for-explicit-version caveat is accurate
  • rc/beta collapse/dedup note is correct
  • Auto-commit/push/PR flow properly replaces the old manual commit step
  • v prefix requirement for compare links is correct (matches update-changelog.md line 200)
  • Option A post-release instructions updated correctly

One gap in .claude/commands/update-changelog.md

The single-line fix ("changelog headings and git tags" → "git tags only") is correct, but the "Before a release" section earlier in the same file still has two stale lines that weren't updated — see the inline comment. They describe the old manual commit/push workflow and still say "auto-computed from changelog content", which directly contradicts the fix made on line 163. Worth addressing in a follow-up (or a quick squash onto this PR) to keep the command file internally consistent.

@justin808
Copy link
Copy Markdown
Member Author

Addressed the stale "Before a release" summary block in update-changelog.md (lines 26–30) in 27c288a:

  • Updated to mention explicit version support (rc, beta, or explicit like 16.5.0.rc.10)
  • Replaced "Commit and push CHANGELOG.md" with "The command automatically commits, pushes, and opens a PR — review and merge it"
  • Also fixed the mastermain branch check on line 327

This addresses the feedback from @claude[bot] and @greptile-apps[bot] about the stale manual workflow instructions contradicting Step 5's auto-PR behavior.

Comment thread .claude/commands/update-changelog.md
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread .claude/commands/update-changelog.md
Comment thread internal/contributor-info/releasing.md Outdated
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 22, 2026

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.

justin808 and others added 4 commits March 22, 2026 12:52
- 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]>
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 22, 2026

Review: Sync release docs with recent changelog automation changes

This is a clean documentation-only PR. The changes accurately reflect the current automation behavior.

What's done well

  • All master to main references in git commands, compare link examples, and branch checks are updated consistently across both files.
  • The prerelease index description fix ("git tags only, not changelog headers") matches the actual compute_auto_version() logic.
  • The new Option A post-release flow correctly adds git pull --rebase before sync_github_release.
  • The explicit version support (16.5.0.rc.10) is documented at both levels (quick summary and detailed process).

Minor gap: missing branch-switch step after merging the auto-PR

The new auto-PR flow in update-changelog.md ("Before a release" section) goes:

  • The command automatically commits, pushes, and opens a PR — review and merge it
  • Then run rake release (no args needed...)

After the auto-PR is merged on GitHub, the user is still on the local changelog-X.Y.Z feature branch. Before running rake release, they need to return to main and pull:

git checkout main
git pull --rebase
bundle exec rake release

The same implicit gap exists in releasing.md Step 1 to Step 2 transition — step 3 says "merge", then the release task section jumps straight to rake release with no branch-switch guidance.

rake release does pull latest changes internally, but only from the current branch — being on the feature branch would pull from the wrong upstream. Adding a one-liner note ("checkout main and pull before running the release task") would close this.

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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After merging the auto-PR, the user is still on the local changelog-X.Y.Z branch. Suggest adding a step here:

Suggested change
- 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
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`

@justin808 justin808 merged commit 8ae0fa2 into main Mar 23, 2026
19 checks passed
@justin808 justin808 deleted the jg/release-docs-sync-recent-changes branch March 23, 2026 00:48
justin808 added a commit that referenced this pull request Mar 25, 2026
## 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]>
justin808 added a commit that referenced this pull request Mar 30, 2026
## 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]>
justin808 added a commit that referenced this pull request Apr 6, 2026
## 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant