Skip to content

Fix changelog version stamping header to mention explicit version support#2807

Merged
justin808 merged 1 commit intomainfrom
jg/2806-changelog-version-header
Mar 23, 2026
Merged

Fix changelog version stamping header to mention explicit version support#2807
justin808 merged 1 commit intomainfrom
jg/2806-changelog-version-header

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 23, 2026

Summary

  • Updates the Version Stamping section header in .claude/commands/update-changelog.md to mention explicit version support (e.g., 16.5.0.rc.10), aligning it with Step 4 and the "Before a release" summary which already documented this correctly.

Fixes #2806

Test plan

  • Verified the updated line matches the suggested fix in the issue

🤖 Generated with Claude Code


Note

Low Risk
Low risk documentation-only change clarifying that the changelog stamping rake task can be invoked with an explicit version string. No runtime or release logic was modified.

Overview
Updates .claude/commands/update-changelog.md to explicitly document that version stamping via the rake task applies not only to release/rc/beta modes but also when an explicit version (e.g., 16.5.0.rc.10) is provided.

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

Summary by CodeRabbit

  • Documentation
    • Updated guidance on when to use the version-stamping rake task, now including scenarios with explicit version arguments in addition to release modes.

…port

The Version Stamping section header didn't mention explicit version
support (e.g., 16.5.0.rc.10), even though Step 4 and the "Before a
release" summary already documented it correctly.

Fixes #2806

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 23, 2026

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: d6bc8e28-c09f-4f63-be07-896b2746e0bb

📥 Commits

Reviewing files that changed from the base of the PR and between fded819 and 283793b.

📒 Files selected for processing (1)
  • .claude/commands/update-changelog.md

Walkthrough

The .claude/commands/update-changelog.md documentation is updated to clarify that the version-stamping rake task should be used for release, rc, beta modes, and when explicit versions are provided (e.g., 16.5.0.rc.10)—aligning the header with existing detailed instructions.

Changes

Cohort / File(s) Summary
Documentation - Version Stamping Section
.claude/commands/update-changelog.md
Updated the "Version Stamping" header to include explicit version support (e.g., 16.5.0.rc.10) alongside release, rc, and beta modes, ensuring consistency with Step 4 and other sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A changelog grows clearer now,
Version stamps, explicit, take a bow,
Release, rc, beta—and versions too,
The rake task knows just what to do! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main change: updating documentation to clarify explicit version support in changelog version stamping.
Linked Issues check ✅ Passed The code change directly implements the objective from issue #2806 by updating the Version Stamping header to mention explicit version support as suggested.
Out of Scope Changes check ✅ Passed All changes are strictly within scope: only the Version Stamping header documentation line was modified to address issue #2806 requirements.
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/2806-changelog-version-header

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.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 23, 2026

Reviewed the change. This is a clean, minimal documentation fix that correctly aligns the "Version Stamping" section header with the rest of the document.

The explicit version case is already well-documented in Step 4 (line 279) and in the "Before a release" summary (line 26), so this one-line update closes the gap in the introductory description of when the rake task is invoked. No logic, behavior, or tests are affected.

LGTM.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Mar 23, 2026

Greptile Summary

This is a minimal, one-line documentation fix in .claude/commands/update-changelog.md. The "Version Stamping with Rake Task" section header previously omitted the explicit version invocation mode (e.g., /update-changelog 16.5.0.rc.10), which was already documented correctly at lines 13 and 26. The change brings this section into alignment with the rest of the file.

  • Updates the section header to add or an explicit version (e.g., \16.5.0.rc.10`)alongsiderelease, rc, and beta`
  • No logic, code, or behavior changes — documentation only
  • Consistent with the "Arguments" section (line 13) and the "Before a release" summary (line 26) which already listed explicit versions

Confidence Score: 5/5

  • This PR is safe to merge — it is a one-line documentation fix with no code, logic, or behavior changes.
  • The change is a single-line wording update in a markdown documentation file. It correctly aligns the "Version Stamping with Rake Task" section header with the already-correct descriptions at lines 13 and 26 of the same file. There are no risks of regression, no code affected, and the fix is accurate.
  • No files require special attention.

Important Files Changed

Filename Overview
.claude/commands/update-changelog.md Single-line documentation fix aligning the "Version Stamping with Rake Task" section header to also mention explicit version support (e.g., 16.5.0.rc.10), consistent with lines 13 and 26 of the same file.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["/update-changelog $ARG"] --> B{Argument?}
    B -- "no arg" --> C["Add entries to [Unreleased]\nNo version stamp"]
    B -- "release / rc / beta" --> D["Add entries\n+ Auto-compute next version\n+ Rake task stamps version header"]
    B -- "explicit version\ne.g. 16.5.0.rc.10" --> E["Add entries\n+ Use provided version directly\n(skip auto-computation)\n+ Rake task stamps version header"]
    D --> F["Commit, push, open PR"]
    E --> F
Loading

Reviews (1): Last reviewed commit: "Fix changelog version stamping header to..." | Re-trigger Greptile

@justin808 justin808 merged commit 5846a94 into main Mar 23, 2026
10 checks passed
@justin808 justin808 deleted the jg/2806-changelog-version-header branch March 23, 2026 05:03
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
…port (#2807)

## Summary
- Updates the Version Stamping section header in
`.claude/commands/update-changelog.md` to mention explicit version
support (e.g., `16.5.0.rc.10`), aligning it with Step 4 and the "Before
a release" summary which already documented this correctly.

Fixes #2806

## Test plan
- [x] Verified the updated line matches the suggested fix in the issue

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk documentation-only change clarifying that the changelog
stamping rake task can be invoked with an explicit version string. No
runtime or release logic was modified.
> 
> **Overview**
> Updates `.claude/commands/update-changelog.md` to explicitly document
that version stamping via the rake task applies not only to
`release`/`rc`/`beta` modes but also when an explicit version (e.g.,
`16.5.0.rc.10`) is provided.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
283793b. 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**
* Updated guidance on when to use the version-stamping rake task, now
including scenarios with explicit version arguments in addition to
release modes.

<!-- 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 Apr 6, 2026
…port (#2807)

## Summary
- Updates the Version Stamping section header in
`.claude/commands/update-changelog.md` to mention explicit version
support (e.g., `16.5.0.rc.10`), aligning it with Step 4 and the "Before
a release" summary which already documented this correctly.

Fixes #2806

## Test plan
- [x] Verified the updated line matches the suggested fix in the issue

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk documentation-only change clarifying that the changelog
stamping rake task can be invoked with an explicit version string. No
runtime or release logic was modified.
> 
> **Overview**
> Updates `.claude/commands/update-changelog.md` to explicitly document
that version stamping via the rake task applies not only to
`release`/`rc`/`beta` modes but also when an explicit version (e.g.,
`16.5.0.rc.10`) is provided.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
283793b. 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**
* Updated guidance on when to use the version-stamping rake task, now
including scenarios with explicit version arguments in addition to
release modes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Claude Opus 4.6 (1M context) <[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.

update-changelog.md: Version Stamping header should mention explicit version support

1 participant