Skip to content

fix(release): strip -rcN suffix when extracting CHANGELOG notes#66

Merged
vxcozy merged 1 commit into
mainfrom
fix/release-notes-strip-rc
Apr 19, 2026
Merged

fix(release): strip -rcN suffix when extracting CHANGELOG notes#66
vxcozy merged 1 commit into
mainfrom
fix/release-notes-strip-rc

Conversation

@vxcozy
Copy link
Copy Markdown
Owner

@vxcozy vxcozy commented Apr 19, 2026

Summary

One-line awk fix: RCs now share release notes with their target version. v1.2.1-rc1 matches ## [1.2.1] in CHANGELOG.md instead of the non-existent ## [1.2.1-rc1].

Why

Caught by the v1.2.1-rc1 dry-run for v1.2.1:

  • ✅ 4/4 builds green
  • release step failed — `release-notes.md is empty — CHANGELOG.md has no [1.2.1-rc1] section`
  • ⏭️ homebrew-tap correctly skipped via `-rc` guard

Prior convention required a per-RC `## [1.2.1-rc1]` CHANGELOG stanza (see PR #52 for v1.1.0-rc1). That's wasteful: RCs and their real release describe the same thing. Stripping the suffix means we stop maintaining throwaway stanzas forever.

Behavior

  • v1.2.1-rc1BASE_VERSION=1.2.1 → extracts ## [1.2.1] section.
  • v1.2.1BASE_VERSION=1.2.1 → extracts ## [1.2.1] section (unchanged).
  • v2.0.0-rc3BASE_VERSION=2.0.0 → extracts ## [2.0.0] section.
  • If the base version's stanza is missing from CHANGELOG, the error message now names the base version (actionable).

Follow-up tag plan

After this merges: cut v1.2.1-rc2 to re-validate. Expect 5 green jobs + tap-bump skipped. Then cut real v1.2.1.

Test plan

  • cargo fmt --check
  • cargo clippy --workspace --all-targets -- -D warnings
  • cargo test --workspace --all-features
  • YAML syntax-check
  • v1.2.1-rc2 release.yml run completes green through the release step

RCs share release notes with their target version, so the awk
lookup should match ## [X.Y.Z] even when the tag is vX.Y.Z-rcN.
Removes the need to maintain throwaway ## [X.Y.Z-rcN] stanzas
(the old convention, which caused v1.2.1-rc1 to fail).

Caught by the v1.2.1-rc1 dry run failing at the release step
while all 4 builds + the RC tap-bump-skip behaved correctly.
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@vxcozy vxcozy merged commit bb03eb6 into main Apr 19, 2026
12 checks passed
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