Skip to content

Release process

Samuel D. Leslie edited this page Jun 2, 2022 · 5 revisions

Instructions assume a correctly configured development environment.

Preparation

  1. Update the version in the VERSION file.
  2. Update CHANGELOG.md (review the commit history).
  3. Push all commits on main and check all builds pass.

Releasing

  1. Build the source distribution: python setup.py sdist
  2. Build the universal wheel: python setup.py bdist_wheel
  3. Sanity check the distribution: twine check dist/*
  4. Upload the new release: twine upload dist/*

Consult the internal documentation (Draftable employees only) for credentials suitable for publishing.

Post-release

  1. Add a new Git tag corresponding to the release.
  2. Fast-forward the stable branch to match main.
  3. Update any internal repositories to use the new version.
Clone this wiki locally