Skip to content

Fix version link formatting in CHANGELOG.md#2263

Merged
ihabadham merged 2 commits intomasterfrom
justin808-patch-1
Dec 30, 2025
Merged

Fix version link formatting in CHANGELOG.md#2263
ihabadham merged 2 commits intomasterfrom
justin808-patch-1

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Dec 30, 2025

Corrected the link format for version comparison.

Summary

Remove this paragraph and provide a general description of the code changes in your pull
request... were there any bugs you had fixed? If so, mention them. If
these bugs have open GitHub issues, be sure to tag them here as well,
to keep the conversation linked together.

Pull Request checklist

Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by ~.

  • Add/update test to cover these changes
  • Update documentation
  • Update CHANGELOG file

Add the CHANGELOG entry at the top of the file.

Other Information

Remove this paragraph and mention any other important and relevant information such as benchmarks.

Summary by CodeRabbit

  • Chores
    • Updated changelog link formatting for improved documentation accuracy (adjusts how compare links are formed).

Note: This release contains no new features, bug fixes, or functional changes visible to end-users.

✏️ Tip: You can customize this high-level summary in your review settings.

Corrected the link format for version comparison.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 30, 2025

Walkthrough

Updated two CHANGELOG.md compare links for the 16.2.0.rc.0 entry: removed the leading "v" from the left-side version in the URL path (changed compare/v16.1.1...v16.2.0.rc.0 to compare/16.1.1...v16.2.0.rc.0). No code or behavioral changes.

Changes

Cohort / File(s) Summary
Changelog documentation
CHANGELOG.md, react_on_rails_pro/CHANGELOG.md
Adjusted two compare-link URLs for v16.2.0.rc.0 by removing the leading v from the left-side version in the path (compare/v16.1.1...v16.2.0.rc.0compare/16.1.1...v16.2.0.rc.0). Documentation-only edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

AI_ON

Suggested reviewers

  • AbanoubGhadban
  • alexeyr-ci2

Poem

🐰 I hopped through lines of text so spry,

Fixed a path and waved goodbye,
A tiny "v" no longer stays,
Now compare links skip the maze,
Hooray — the CHANGELOG's clear and spry!

Pre-merge checks and finishing touches

✅ 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 'Fix version link formatting in CHANGELOG.md' directly and clearly describes the main change—correcting link format issues in the CHANGELOG files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch justin808-patch-1

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 45593a4 and ea8e54b.

📒 Files selected for processing (1)
  • react_on_rails_pro/CHANGELOG.md
✅ Files skipped from review due to trivial changes (1)
  • react_on_rails_pro/CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: markdown-link-check
  • GitHub Check: claude-review

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 Dec 30, 2025

Code Review

Thank you for the PR! I've reviewed the changes and have the following feedback:

🔍 Issue Analysis

The PR changes line 1876 from:

[16.2.0.rc.0]: https://github.com/shakacode/react_on_rails/compare/v16.1.1...v16.2.0.rc.0

to:

[16.2.0.rc.0]: https://github.com/shakacode/react_on_rails/compare/16.1.1...v16.2.0.rc.0

The change removes the v prefix from the base version (v16.1.116.1.1).

What's Correct

  1. Consistency within the file: Looking at the CHANGELOG.md, the vast majority of version comparison links (lines 1877-1889 and beyond) use versions without the v prefix:

    • [16.1.1]: ...compare/16.1.0...16.1.1
    • [16.1.0]: ...compare/16.0.0...16.1.0
    • [16.0.0]: ...compare/14.2.0...16.0.0
  2. Pattern matching: This change makes the link consistent with the established pattern used throughout the file.

⚠️ Concerns

  1. Incomplete fix: The [unreleased] link on line 1875 also uses the v prefix:

    [unreleased]: https://github.com/shakacode/react_on_rails/compare/v16.2.0.rc.0...master
    

    For consistency, this should probably be:

    [unreleased]: https://github.com/shakacode/react_on_rails/compare/16.2.0.rc.0...master
    
  2. Mixed patterns in old versions: The file does have some legacy links with v prefixes (versions 1.x and 2.x), but the modern convention (14.x, 16.x) consistently uses no prefix.

  3. Checklist not completed: The PR template asks for:

    • Add/update test to cover these changes (N/A for docs)
    • Update documentation (N/A)
    • Update CHANGELOG file (this IS the changelog)

    The PR body still has the template boilerplate. Consider updating it with:

    • Brief description of what was wrong
    • Why this format is correct
    • Acknowledge the unreleased link needs fixing too

📋 Recommendations

  1. The change is correct - removing the v prefix is the right call for consistency
  2. 🔧 Also fix the [unreleased] link on line 1875 to remove the v prefix
  3. 📝 Update the PR description to explain the fix more clearly
  4. 🧪 Testing: Not applicable for CHANGELOG formatting

🎯 Suggested Additional Change

-[unreleased]: https://github.com/shakacode/react_on_rails/compare/v16.2.0.rc.0...master
+[unreleased]: https://github.com/shakacode/react_on_rails/compare/16.2.0.rc.0...master

This would make both recent links consistent with the established pattern used throughout the changelog.


Overall: The change is correct and improves consistency. With the additional fix to the [unreleased] link, this will be ready to merge.

ihabadham added a commit that referenced this pull request Dec 30, 2025
PR #1856 unintentionally introduced a `v` prefix to git tags when it
replaced `release-it` with manual git commands. The `release-it` tool
auto-detected the existing tag format (no `v` prefix), but the manual
implementation explicitly added `v#{version}`.

This broke 9+ years of consistent tagging convention (versions 2.0.0
through 16.1.2 all used no `v` prefix) and caused issues like broken
CHANGELOG links (fixed in PR #2263).

Changes:
- Remove `v` prefix from tag creation in release.rake
- Update releasing.md to document the correct convention
- Update update-changelog.md to reflect no `v` prefix for future tags
- Add notes about historical v16.2.0.beta.x tags that have `v` prefix

Fixes #2267

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
The tag v16.1.1 does not exist - only 16.1.1 exists (without v prefix).
This is the same fix as the previous commit but for react_on_rails_pro/CHANGELOG.md.

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@coderabbitai coderabbitai Bot added the AI_ON label Dec 30, 2025
@ihabadham ihabadham removed the AI_ON label Dec 30, 2025
@ihabadham ihabadham merged commit 3efa19d into master Dec 30, 2025
3 checks passed
@ihabadham ihabadham deleted the justin808-patch-1 branch December 30, 2025 17:50
ihabadham added a commit that referenced this pull request Dec 30, 2025
PR #1856 unintentionally introduced a `v` prefix to git tags when it
replaced `release-it` with manual git commands. The `release-it` tool
auto-detected the existing tag format (no `v` prefix), but the manual
implementation explicitly added `v#{version}`.

This broke 9+ years of consistent tagging convention (versions 2.0.0
through 16.1.2 all used no `v` prefix) and caused issues like broken
CHANGELOG links (fixed in PR #2263).

Changes:
- Remove `v` prefix from tag creation in release.rake
- Update releasing.md to document the correct convention
- Update update-changelog.md to reflect no `v` prefix for future tags
- Add notes about historical v16.2.0.beta.x tags that have `v` prefix

Fixes #2267

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
ihabadham added a commit that referenced this pull request Dec 30, 2025
PR #1856 unintentionally introduced a `v` prefix to git tags when it
replaced `release-it` with manual git commands. The `release-it` tool
auto-detected the existing tag format (no `v` prefix), but the manual
implementation explicitly added `v#{version}`.

This broke 9+ years of consistent tagging convention (versions 2.0.0
through 16.1.2 all used no `v` prefix) and caused issues like broken
CHANGELOG links (fixed in PR #2263).

Changes:
- Remove `v` prefix from tag creation in release.rake
- Update releasing.md to document the correct convention
- Update update-changelog.md to reflect no `v` prefix for future tags
- Add notes about historical v16.2.0.beta.x tags that have `v` prefix

Fixes #2267

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants