Dominik Jain
6da423c70a
bump_version could previously only create releases. It now provides two
subcommands, and the mutually exclusive --major/--minor/--patch flags (as
well as the explicit --version option) are replaced by a positional
argument, which cannot be misused:
bump_version.py release <current|major|minor|patch>
bump_version.py dev <major|minor|patch>
`dev` bumps the version to a new .dev0 version and commits it as
"Set version to vX" without creating a tag or touching the changelog. This
allows work on main to target a new minor/major version independently of a
release.
Because a .dev0 version no longer necessarily reserves the next patch
version, `release` now takes the target "current", which releases the
version reserved by the current .dev version (the usual case), whereas
major/minor/patch bump beyond it. The former special case of not
incrementing the patch version is thereby removed; `release patch` now
increments the patch version as its name suggests.
`release current` fails if the current version is not a development
version, in which case there is no reserved version to release.
1.9 KiB
Developer Instructions
Python Environment & Development Tools
See the contributing guide for instructions on setting up your development environment and tools for formatting and type checking.
Release Process
-
Ensure clean git status.
-
Set the version for release. Normally, the version to be released is the one already reserved by the current
.dev0version (e.g.1.8.0when the repository is at1.8.0.dev0):python scripts/bump_version.py release currentTo release a version beyond the reserved one, name the part to bump instead, e.g.
python scripts/bump_version.py release patch python scripts/bump_version.py release minorThis updates
CHANGELOG.md, commits the release version, creates the git tag, and then commits the subsequent.dev0version for the next iteration. -
Push to GitHub:
git push git push --tagsImportant: This must push a single tag only! Pushing the single tag triggers the
create-releaseworkflow for the tag, which creates a draft release on GitHub. -
Review the draft release on the GitHub Releases page. When ready, publish it (click Publish release). This triggers the
publishworkflow, which builds and publishes the package to PyPI.
Bumping the Development Version
Independently of a release, the development version can be bumped, e.g. when work on main
begins to target a new minor or major version:
python scripts/bump_version.py dev minor
python scripts/bump_version.py dev major
This sets the version to the respective new .dev0 version (e.g. 1.8.0.dev0) and commits it as
"Set version to vX"; it creates no tag and does not modify CHANGELOG.md.
The subsequent release of that version is then performed with release current.
Both commands require a clean git status and support --dry-run to preview the changes.