Create a release/x.y.z branch and generate release notes from the latest tag to HEAD, then update CHANGELOG.md.
- Create a release branch:
release/x.y.z - Generate release notes from the latest tag
- Prepend the new section to
CHANGELOG.md
- Run inside a Git repository
- At least one tag exists (or provide
--tag) - Python 3 is available
Place this folder under your Codex skills directory:
- Default location:
$CODEX_HOME/skills/release-branch-notes - Common default for
CODEX_HOME:$HOME/.codex
Example (copy):
cp -R "./release-branch-notes" "$CODEX_HOME/skills/release-branch-notes"Example (symlink):
ln -s "$(pwd)" "$CODEX_HOME/skills/release-branch-notes"Restart Codex CLI (or reload skills if your environment supports it) to pick up the new skill.
Mention the skill name in your prompt and provide a version:
Use release-branch-notes to create release/1.2.3 and update CHANGELOG.md
You can also specify --base and --tag if needed:
Use release-branch-notes with version 1.2.3, base main, tag v1.2.2
./scripts/release_branch_notes.py --version x.y.zOptional arguments:
--base <branch>: create the release branch from the specified base branch--tag <tag>: override the default start tag
Example:
./scripts/release_branch_notes.py --version 1.2.3 --base main --tag v1.2.2- Breaking: subject contains
!or body includesBREAKING CHANGE - Features:
featcommits - Fixes:
fixcommits - All other types are ignored
- Empty categories output
- None
## x.y.z - YYYY-MM-DD
### Breaking
- None
### Features
- Add new behavior
### Fixes
- Fix a bug- A dirty working tree prints a warning but does not abort
- Fails fast if the branch already exists or no tags are found
- Does not run
git commit/git push/git fetch