Skip to content

Release checklist

PyPI Release Checklist

For Every Release

  1. Check out release branch, merge all changes from master/main to release

  2. Run the tests:

    1
    tox

  3. Update HISTORY.md

    Be noticed that github workflow will generate a changelog for you automatically.

  4. Commit the changes:

    1
2
    git add HISTORY.md
git commit -m "Changelog for upcoming release 0.1.1."

  5. Update version number. The following are an example of executing and the contents of the push-version.ps1 script at the root of the repository.

    1
    .\push-version.ps1 0.1.1 "documentation updates"

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    param(
    [Parameter(Mandatory,
        HelpMessage="Enter a valid version number #.#.#")]
    [ValidatePattern("\d+\.\d+\.\d+")]
    [string]$version,
    [Parameter(Mandatory)]
    [string]$message
)

poetry version $version # update the version in pyproject.toml
git add -A # add the updated pyproject.toml
git commit -m "v$version"
git tag v$version -m $message
git push --atomic origin master v$version

  6. Check the CodeArtifact listing page to make sure that the README, release notes, and roadmap display properly. If tox test passed, this should be ok, since we have already run twine check during tox test.