burnman
burnman copied to clipboard
BurnMan release checklist
This checklist should be completed for every release of BurnMan WARNING: New releases are automatically uploaded to PyPi. Make sure everything is right before you make the new release.
- [ ] Check new version can be used non-locally (
python -m pip install ., then run from another directory) - [ ] Create a new branch (burnman-Major.Minor)
- [ ] Bump version number in new branch (in pyproject.toml)
- [ ] Update changelog.txt with major changes since the last release.
- [ ] Update pyproject.toml (if necessary, probably only Python versions need checking (as we've checked the installation works above)
- [ ] Prepare release on zenodo
- [ ] Open zenodo (https://zenodo.org/record/7080174)
- [ ] Start new version, reserve DOI (currently at the top of Basic Information)
- [ ] Update new link to the zenodo version (using the new reserved DOI) in burnman/init.py
- [ ] Update new link to the zenodo version (using the new reserved DOI) in docs/index.rst
- [ ] Update new badge link to zenodo (using the new reserved DOI) in Readme.md
- [ ] Update author list in zenodo.
- [ ] Prepare release on Github
- [ ] Push new branch to Github upstream burnman-Major.Minor (not main)
- [ ] Make release on Github using upstream burnman-Major.Minor branch
- [ ] Release documentation on readthedocs
- [ ] Make release commit (tag, not branch) active on readthedocs (you'll need to build from master first so that ReadTheDocs finds the new release tag)
- [ ] Build documentation on readthedocs
- [ ] Download zip file from readthedocs
- [ ] Finalise zenodo
- [ ] Upload new zip file to zenodo, fill in details on website (including new link to ReadTheDocs and github version)
- [ ] Save and publish in zenodo
- [ ] Finalise GitHub
- [ ] Update GitHub release with new zip files and link to the ReadTheDocs documentation
- [ ] Merge upstream burnman-Major.Minor branch to main
- [ ] Bump version numbers in pyproject.toml on upstream main to
[Major].[Minor].[Patch+1]a0 - [ ] Check and update homepage (especially the downloads section for version numbers and the zenodo links)