Releases promote reviewed changes to main. Merging a release PR automatically
starts validation and building. Publication waits for approval of the pypi
environment.
- Create the GitHub environment
pypiand restrict deployment branches tomain. Configure the repository's required release reviewers before publishing. - On PyPI, configure a Trusted Publisher for the existing
paywithextendproject: ownerpaywithextend, repositoryextend-python, workflowrelease.yml, environmentpypi. - Verify both configurations before releasing. The workflow uses GitHub OIDC;
the legacy
PYPI_API_TOKENsecret is not used. Do not remove legacy credentials until the replacement publisher has been verified.
- Update
extend/__version__.py, the changelog and migration notes together. - Open a release PR to
main; require review and successful Python 3.11–3.14 CI. - Merge the release PR. Publish reviewed SDK starts automatically on
main, reads the version from that exact commit, and skips versions with an existing GitHub release. Never reuse a published version or move its tag. - After source tests, installed-wheel tests and runtime advisory checks pass,
an authorized reviewer approves the
pypideployment in the Actions run. GitHub publishes the validated artifacts through OIDC, then creates the version tag and GitHub release at the merged commit using the changelog as release notes. - Confirm both distributions exist on PyPI and a fresh installation reports the
expected version. For a failed run, use Re-run failed jobs. Publication skips
existing files so a partial upload or GitHub release failure can be recovered
without replacing published files. Run workflow on
mainremains available for recovery; no tag input or manual tag creation is needed. - Merge release-only metadata changes back into
developmentwhen necessary.
Publish SDK 3.0.0 before releasing packages that require paywithextend==3.0.0.
A successful offline test run does not establish live endpoint availability or
account permissions. See the availability notes in the README.