Maintainer Notes

These notes are directed towards helping with the maintenance of the Specter project.

Releasing a new version of Specter

  1. Start with a fresh local branch.

    git checkout -b prep_for_release
  2. Update and commit release notes in docs/release_notes/index.rst.

  3. Execute bumpversion.

    # Available parts: major, minor, patch
    bumpversion <part>
  4. Push up branch and tag

    git push origin prep_for_release --tags
  5. Create PR.

  6. Wait for CI to pass and PR to merge.

  7. Remove old packages

    rm -r dist
  8. Build sdist and wheel

    python sdist
    python bdist_wheel
  9. Upload to PyPI

    twine upload dist/*