| name | gh-release |
| description | Automates version bumping in pyproject.toml and creating GitHub releases. Use when releasing a new version of the project. |
GitHub Release Skill
Overview
This skill automates the process of creating a new release for this Python project. It updates the version in pyproject.toml, commits the change, and then creates a GitHub release using the gh CLI tool.
Semantic Versioning (SemVer)
This project follows Semantic Versioning (SemVer) for releasing versions. SemVer uses a MAJOR.MINOR.PATCH format:
- MAJOR version when you make incompatible API changes.
- MINOR version when you add functionality in a backward compatible manner.
- PATCH version when you make backward compatible bug fixes.
Example: 1.0.0 -> 1.1.0 (new feature), 1.1.0 -> 1.1.1 (bug fix), 1.1.1 -> 2.0.0 (breaking change).
Usage
To use this skill, execute the create-release.sh script from the root of your project with the desired new version number as an argument.
Example:
.agent/skills/gh-release/scripts/create-release.sh 0.9.1
This will perform the following actions:
- Ensure the working directory is clean and in the
main branch.
- Update the
version field in pyproject.toml to 0.9.1.
- Stage the
pyproject.toml file.
- Commit the change with the message
chore(release): 0.9.1.
- Push the changes to the
main branch.
- Create a GitHub release named
0.9.1 with auto-generated release notes using gh release create "0.9.1" --generate-notes.
Requirements
gh CLI tool must be installed and authenticated.- The script should be run from the root of the project repository.
- The script expects to find
pyproject.toml in the root.
Resources
scripts/
create-release.sh: The main script that performs the release automation.
