Skip to content

Add rake changelog task (git-cliff) - #1744

Merged
klobuczek merged 1 commit into
12from
rake-changelog
Aug 17, 2026
Merged

Add rake changelog task (git-cliff)#1744
klobuczek merged 1 commit into
12from
rake-changelog

Conversation

@klobuczek

@klobuczek klobuczek commented Aug 17, 2026

Copy link
Copy Markdown
Member

Adds the changelog rake task, matching neo4j-ruby-driver, to complete the git-cliff release procedure (which already has cliff.toml and the tag-triggered release.yml).

rake changelog                      # refresh the [Unreleased] section from merged PRs
rake "changelog[v12.0.0.beta.7]"    # finalize a version section at release

Wraps git cliff -o CHANGELOG.md. When a tag is given it's validated against \Av\d[\w.-]*\z and passed to sh as an array (no shell interpolation, so the tag can't inject commands).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • Added a changelog task to generate or refresh the project changelog.
    • Supports optional version tags with validation before generation.

Wraps git-cliff to regenerate CHANGELOG.md from commits, completing the
release procedure alongside cliff.toml and release.yml. Pass a release tag to
finalize a version section: rake "changelog[v12.0.0.beta.7]". The tag is
validated and passed to sh as an array (no shell interpolation).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 17, 2026 02:18
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a88d58ca-9be2-4f2b-b516-93e7c00ac375

📥 Commits

Reviewing files that changed from the base of the PR and between 4f48397 and 305ac90.

📒 Files selected for processing (1)
  • Rakefile

Included review availability: Your plan includes up to 4 reviews per rolling hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The Rakefile adds a changelog[tag] task. The task validates an optional version tag and invokes git cliff without shell interpolation to regenerate CHANGELOG.md.

Changes

Changelog generation

Layer / File(s) Summary
Validated changelog task
Rakefile
Adds the changelog[tag] task, documents its usage, validates optional version tags, and invokes git cliff to write CHANGELOG.md without a shell.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 305ac

This localized change adds a validated changelog task without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review.

🚥 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 clearly and concisely describes the added Rake changelog task and its use of git-cliff.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rake-changelog

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a new changelog Rake task to support the project’s git-cliff-based release workflow by regenerating CHANGELOG.md, optionally finalizing a specified version section via a validated tag.

Changes:

  • Introduces rake changelog to regenerate CHANGELOG.md using git-cliff.
  • Adds optional tag argument handling with validation and safe argument passing to sh (no shell interpolation).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@klobuczek
klobuczek merged commit 9fd48c5 into 12 Aug 17, 2026
19 checks passed
@klobuczek
klobuczek deleted the rake-changelog branch August 17, 2026 02:27
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.

2 participants