Skip to content

📝 Generate CLI release notes with Codex#282

Merged
Robdel12 merged 1 commit into
mainfrom
rd/codex-release-notes
May 27, 2026
Merged

📝 Generate CLI release notes with Codex#282
Robdel12 merged 1 commit into
mainfrom
rd/codex-release-notes

Conversation

@Robdel12

Copy link
Copy Markdown
Contributor

Summary

This PR updates the main CLI release workflow to use openai/codex-action for GitHub release notes.

The current release notes are technically correct, but they are just commit subjects. That works when every commit is perfectly written. It falls apart when the interesting part is in the diff: docs changes, CLI behavior tweaks, test/supporting work, or a PR that bundles a few related files together.

The new flow asks Codex to inspect the actual release diff and write concise Keep a Changelog-style notes. The prompt is intentionally restrained: no invented features, no marketing polish, no raw commit dump, and no command log. Just the user-facing changes that are actually in the release.

What Changed

  • Replaced the commit-list-only release note generation in .github/workflows/release.yml with openai/codex-action.
  • Instructed Codex to inspect the tag-to-HEAD diff and read files when commit messages are not enough.
  • Writes generated notes to RELEASE_NOTES.md, then passes that file into the GitHub Release body.
  • Keeps a fallback path that generates the old commit-subject notes if Codex does not produce a file.

Why

This gives us release notes that are still simple, but much more useful. The goal is not fancy copy. The goal is grounded notes that explain what changed in a way a user can scan quickly.

Verification

Validated the workflow YAML locally and checked the diff for whitespace issues. actionlint is not installed locally, so this has not been run through actionlint.

Use Codex to write grounded release notes from the real release diff, with the old commit-list output as a fallback if generation fails.
@vizzly-testing

Copy link
Copy Markdown

Vizzly - Visual Test Results

CLI Reporter - Waiting for build

No builds received yet for this pull request.

CLI TUI - Approved

5 comparisons, no changes detected.

View build


rd/codex-release-notes · 3eaedc60

@Robdel12 Robdel12 marked this pull request as ready for review May 27, 2026 22:20
@Robdel12 Robdel12 merged commit 77fb046 into main May 27, 2026
29 checks passed
@Robdel12 Robdel12 deleted the rd/codex-release-notes branch May 27, 2026 22:20
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