chore: add v6.2.2 changelog and use CHANGELOG.md for GH release notes#2127
chore: add v6.2.2 changelog and use CHANGELOG.md for GH release notes#2127
Conversation
Update publish workflow to extract release notes from CHANGELOG.md instead of using --generate-notes, with fallback if no entry found.
🤖 Augment PR SummarySummary: Updates the publish workflow to create GitHub Releases using curated notes extracted from 🤖 Was this summary useful? React with 👍 or 👎 |
| gh release create "$TAG" --generate-notes | ||
| VERSION="${TAG#v}" | ||
| # Extract the current version's section from CHANGELOG.md | ||
| BODY=$(awk -v ver="$VERSION" ' |
There was a problem hiding this comment.
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
🤖 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 } |
There was a problem hiding this comment.
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
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe GitHub Release creation workflow for manual Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
--generate-notes, with fallback if no entry foundThis ensures GitHub Releases always use the curated changelog content rather than auto-generated commit lists.
Test plan
awkextraction logic against CHANGELOG.md formatlatestpublish and confirm GH release body matches changelog