Releasing¶
Release process¶
You release tmuxp by tagging a version: pushing a v<version> tag triggers a CI
workflow that builds the package and publishes it to PyPI via
OIDC trusted publishing.
Update
CHANGESwith the release notes.Bump the version in
src/tmuxp/__about__.py.Commit the bump:
$ git commit -m "Tag v<version>"
Tag it:
$ git tag v<version>
Push the commit and the tag:
$ git push && git push --tags
CI builds and publishes to PyPI automatically.
Changelog format¶
CHANGES is rendered as the changelog page. Each release is a Markdown section
headed by its version and date:
## tmuxp <version> (<date>)
### Breaking changes
- Description of the break, with a migration path (#issue)
### What's new
- Description of the feature (#issue)
### Fixes
- Description of the fix (#issue)
Subheadings appear in a fixed order when present: ### Breaking changes,
### Dependencies, ### What's new, ### Fixes, ### Documentation,
### Development.