Skip to content

chore: automate CHANGELOG generation in release workflow#4447

Merged
matthew-dean merged 2 commits into
masterfrom
chore/automate-changelog-generation
Jun 13, 2026
Merged

chore: automate CHANGELOG generation in release workflow#4447
matthew-dean merged 2 commits into
masterfrom
chore/automate-changelog-generation

Conversation

@matthew-dean

@matthew-dean matthew-dean commented Jun 13, 2026

Copy link
Copy Markdown
Member

Removes the manual "Update CHANGELOG.md" checklist item from release PRs by auto-generating the CHANGELOG entry from merged PRs since the last git tag.

Also removes the redundant "Verify all CI checks pass" checklist item — branch protection already enforces this.

Summary by CodeRabbit

  • Chores
    • Improved the automated release workflow to automatically generate and update CHANGELOG entries from merged pull requests, refined version calculation behavior for release branches, and simplified release PR messaging for clearer, more concise release notes.

Updated comments for clarity and consistency in the release PR workflow.
@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jun 13, 2026
@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 110f4b87-8c25-444d-b87d-91b2f9ef1511

📥 Commits

Reviewing files that changed from the base of the PR and between f0096ad and 673edda.

📒 Files selected for processing (1)
  • .github/workflows/create-release-pr.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/create-release-pr.yml

📝 Walkthrough

Walkthrough

This PR updates .github/workflows/create-release-pr.yml to auto-generate changelog entries from merged PRs since the latest tag, refactors NEXT_VERSION calculation for alpha and master, and clarifies comments and the release PR body text.

Changes

Release Automation Workflow

Layer / File(s) Summary
Workflow documentation and control comments
.github/workflows/create-release-pr.yml
Reworded header comments describing release PR automation, adjusted inline comments for infinite-loop prevention covering both squash and regular merges, clarified early-exit wording for no-new-commits, and noted intentional fast-fail for concurrent runs.
Version calculation snippets for master and alpha
.github/workflows/create-release-pr.yml
Refactored inline Node.js code for computing NEXT_VERSION on both branches: alpha uses regex-based increment (alpha.N → alpha.N+1 with fallback), master compares current vs npm published version and patch-increments as needed; formatting changed but behavior preserved.
Release automation: version bumping and changelog generation
.github/workflows/create-release-pr.yml
Extended the release-branch bump step to update version in root and package package.json files, collect merged PRs since the latest git tag via gh pr list, format them into a Changes markdown section, rewrite CHANGELOG.md, stage/commit updates, and simplified the release PR body to include only the backticked NEXT_VERSION.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

size:L

🐰 A tiny hop, a version bump,
Changelogs stitched with gentle thump,
Automation hums,
Release notes drum—
I nibble carrots, then I jump! 🥕✨

🚥 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 describes the main change: automating CHANGELOG generation in the release workflow by adding auto-generation logic to the workflow file.
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.

✏️ 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 chore/automate-changelog-generation

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.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/create-release-pr.yml:
- Line 204: The PR body contains unnecessary escaped dollar signs
(`\$\`${NEXT_VERSION}\$\``) which render literal backslashes; update the string
so the fragment `\$`${NEXT_VERSION}\$`` is replaced with ```${NEXT_VERSION}```
(i.e., remove the backslashes before the $ characters) so the backticks render
as Markdown code with the template variable.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 69829ac6-59f2-49ad-8dd2-d020082ab783

📥 Commits

Reviewing files that changed from the base of the PR and between f4a63f2 and f0096ad.

📒 Files selected for processing (1)
  • .github/workflows/create-release-pr.yml

Comment thread .github/workflows/create-release-pr.yml Outdated
Fix typo in push event and update release message format.
@matthew-dean matthew-dean merged commit a5b62c8 into master Jun 13, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant