release:framework
Introduction
release:framework publishes a new version of splent_framework to the git forge and PyPI, through the release pipeline. It works like release:cli, on splent_framework/.
splent release:framework
Without a version it opens the same bump wizard. Release shows a whole run.
Releasing a given version
splent release:framework 1.30.1
Pass the version in CI, where nobody answers the wizard. It must be MAJOR.MINOR.PATCH, with or without a leading v.
After the release, every running container that installs splent_framework editable from /workspace/splent_framework installs it again, so pip records the new version. A container that cannot be refreshed is named with the command to run by hand.
Reference
| Option | Description |
|---|---|
VERSION |
MAJOR.MINOR.PATCH. Omit it for the wizard |
--skip-checks |
Skip lint and tests, for emergencies only |
--no-forge |
Publish to PyPI only. Nothing goes to the forge for this version |
--no-pypi |
Publish to the forge only. The version will not exist on PyPI |
--allow-unfinished |
Release even though the previous version never finished publishing |
--wait |
Wait for PyPI’s new-project limit however long it takes |
The tests are ruff and pytest tests in splent_framework/. --no-forge and --no-pypi ask you to confirm (see Declaring channels). A step that fails after the upload is a divergence.
Requirements
SPLENT_FORGE_TOKEN, unless--no-forge.TWINE_USERNAMEandTWINE_PASSWORD, unless--no-pypi.- A
splent_framework/checkout with anoriginremote.
Check the tokens with splent check:forge and splent check:pypi.