Skip to content

HowToRelease

Mike Taves edited this page Jul 3, 2024 · 5 revisions

How To Release

  1. Make a new branch: git checkout -b version-0.8
  2. Update the date and change log notes for the release in docs/source/changelog.rst
  3. Update CITATION.cff, modify "version" and "date-released" items
  4. Create a commit with message, e.g., git commit -m "RLS: 0.8", make a Pull Request and Merge if checks look good.
  5. Do a local pull git checkout main && git pull
  6. Tag a release and push git tag 0.8
  7. Push tags to remote git push --tags then wait for docs to be made to copy changelog entries to copy/paste
  8. Create release on GitHub using tag with title, e.g., "Version 0.8" and description from a copy/paste from previous step
  9. (TODO: remove this after publishing is OK). Create package for PyPI with:
pip install build twine
rm -rf build dist *.egg-info
python -m build
python -m twine check --strict dist/*
python -m twine upload dist/*
Clone this wiki locally