Skip to content

chore: add v6.2.2 changelog and use CHANGELOG.md for GH release notes#2127

Merged
bmadcode merged 1 commit intomainfrom
chore/changelog-release-notes
Mar 26, 2026
Merged

chore: add v6.2.2 changelog and use CHANGELOG.md for GH release notes#2127
bmadcode merged 1 commit intomainfrom
chore/changelog-release-notes

Conversation

@bmadcode
Copy link
Copy Markdown
Collaborator

Summary

This ensures GitHub Releases always use the curated changelog content rather than auto-generated commit lists.

Test plan

  • All existing tests pass (243/243)
  • Verify awk extraction logic against CHANGELOG.md format
  • Trigger a latest publish and confirm GH release body matches changelog

Update publish workflow to extract release notes from CHANGELOG.md
instead of using --generate-notes, with fallback if no entry found.
@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 26, 2026

🤖 Augment PR Summary

Summary: Updates the publish workflow to create GitHub Releases using curated notes extracted from CHANGELOG.md for the current version.
Why: Avoids auto-generated release notes, with a fallback to --generate-notes when no matching changelog section is found.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

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

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

gh release create "$TAG" --generate-notes
VERSION="${TAG#v}"
# Extract the current version's section from CHANGELOG.md
BODY=$(awk -v ver="$VERSION" '
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

If CHANGELOG.md is missing/unreadable, BODY=$(awk ...) will fail and (with the default bash -e behavior in Actions) the step will exit before reaching the fallback path. Consider whether you want an explicit guard so releases don’t fail unexpectedly due to changelog extraction errors.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

VERSION="${TAG#v}"
# Extract the current version's section from CHANGELOG.md
BODY=$(awk -v ver="$VERSION" '
/^## v/ { if (found) exit; if (index($0, "## v" ver)) found=1; next }
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

index($0, "## v" ver) can match a prefix (e.g., ## v6.2.2 will also match ## v6.2.20), which could extract the wrong section and publish incorrect release notes. Consider ensuring the version header match is exact.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@bmadcode bmadcode merged commit a5640c8 into main Mar 26, 2026
7 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6ee5f99c-41ca-49f6-87a9-6b28ffb829c2

📥 Commits

Reviewing files that changed from the base of the PR and between 6dd0a97 and 39059e6.

⛔ Files ignored due to path filters (1)
  • CHANGELOG.md is excluded by !CHANGELOG.md
📒 Files selected for processing (1)
  • .github/workflows/publish.yaml

📝 Walkthrough

Walkthrough

The GitHub Release creation workflow for manual latest channel releases now attempts to populate release notes from CHANGELOG.md by extracting the section matching the current package version. If extraction succeeds, it uses the extracted notes; otherwise, it emits a warning and falls back to auto-generating notes.

Changes

Cohort / File(s) Summary
Workflow Release Notes
.github/workflows/publish.yaml
Modified GitHub Release creation step for workflow_dispatch to extract release notes from CHANGELOG.md based on package version, with conditional fallback to --generate-notes if extraction fails.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • chore: unify npm publish workflow #1881: Modifies the same .github/workflows/publish.yaml publish workflow and specifically alters GitHub Release creation logic for manual stable releases, including release-notes generation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/changelog-release-notes

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.

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