Skip to content

A Codex skill that creates a release/x.y.z branch and generates release notes from the latest tag into CHANGELOG.md

License

Notifications You must be signed in to change notification settings

ehmetlabs/release-branch-notes-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

Release Branch Notes

Create a release/x.y.z branch and generate release notes from the latest tag to HEAD, then update CHANGELOG.md.

What This Skill Does

  • Create a release branch: release/x.y.z
  • Generate release notes from the latest tag
  • Prepend the new section to CHANGELOG.md

Prerequisites

  • Run inside a Git repository
  • At least one tag exists (or provide --tag)
  • Python 3 is available

Installation

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.

Using This Skill in Codex

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

Usage

./scripts/release_branch_notes.py --version x.y.z

Optional 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

Release Notes Rules

  • Breaking: subject contains ! or body includes BREAKING CHANGE
  • Features: feat commits
  • Fixes: fix commits
  • All other types are ignored
  • Empty categories output - None

Output Format

## x.y.z - YYYY-MM-DD

### Breaking
- None

### Features
- Add new behavior

### Fixes
- Fix a bug

Notes

  • 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

About

A Codex skill that creates a release/x.y.z branch and generates release notes from the latest tag into CHANGELOG.md

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages