Skip to content

Release steps

Mike Taves edited this page May 24, 2023 · 2 revisions

Release steps

  1. Edit CHANGELOG.md following Keep a Changelog guidelines with:
    • Add new version section at top and date with subsections "Added"/"Changed"/"Fixed" as needed
    • Add new version link at bottom with correct compare URL, also modify the link for "Unreleased"
  2. Edit CITATION.cff, modify "version" and "date-released" items
  3. Create a commit with message, e.g., git commit -m "RLS: 0.4"
  4. Create a tag, e.g., git tag 0.4
  5. Do a git push and git push --tags and observe checks in GitHub
  6. In GitHub, draft new release using the existing tag with title, e.g., "Version 0.4" and description from a copy/paste from CHANGELOG.md
  7. Create packages and upload to PyPI using a few commands with a modern Python version:
pip install build twine
rm -rf build *.egg-info
python -m build
twine check --strict dist/*
twine upload dist/*
Clone this wiki locally