Skip to content

Add release checklist and changelog-driven release notes - #33

Merged
blackopsrepl merged 1 commit into
mainfrom
issue-14-release-checklist
Mar 21, 2026
Merged

Add release checklist and changelog-driven release notes#33
blackopsrepl merged 1 commit into
mainfrom
issue-14-release-checklist

Conversation

@blackopsrepl

Copy link
Copy Markdown
Contributor

Closes #14.

Summary

  • add a repository-level RELEASE.md checklist for public releases
  • make CHANGELOG.md maintainable with an Unreleased section and real release entries
  • update the release workflow to extract notes from CHANGELOG.md and fail if the version entry is missing
  • point maintainers at the checklist from the README release section

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c4fe21080e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/release.yml Outdated
Comment on lines +77 to +79
if [ -z "$CHANGELOG" ]; then
echo "Missing CHANGELOG.md entry for version $VERSION" >&2
exit 1

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Keep the release job compatible with make bump-*

This hard failure breaks the repository's existing bump-and-tag flow. The documented bump targets in Makefile:165-177 still call commit-and-tag-version, and the repo's own generated release commit (86683a6) shows that helper can create a ## <version> heading with no body at all under this commit history. In that case awk returns an empty string here, so the tag push passes tests but the GitHub Release job aborts. Either the bump helper/config needs to stop auto-generating the changelog/tag, or this step needs a fallback instead of exit 1.

Useful? React with 👍 / 👎.

@blackopsrepl
blackopsrepl force-pushed the issue-14-release-checklist branch from c4fe210 to 9d72506 Compare March 21, 2026 13:10
@blackopsrepl
blackopsrepl merged commit 1d73ae4 into main Mar 21, 2026
1 check passed
@blackopsrepl
blackopsrepl deleted the issue-14-release-checklist branch May 15, 2026 18: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.

Establish a real release checklist and maintain a useful changelog

1 participant