Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BurnMan release checklist #434

Open
21 tasks
bobmyhill opened this issue Oct 8, 2021 · 0 comments
Open
21 tasks

BurnMan release checklist #434

bobmyhill opened this issue Oct 8, 2021 · 0 comments
Projects
Milestone

Comments

@bobmyhill
Copy link
Member

bobmyhill commented Oct 8, 2021

This checklist should be completed for every release of BurnMan

  • Check new version can be used non-locally (python -m pip install ., then run from another directory)
  • Open zenodo (https://zenodo.org/record/7080174), start new version, reserve DOI (currently at the top of Basic Information)
  • 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)
  • 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
  • Push new branch to Github upstream burnman-Major.Minor (not master)
  • Make release on Github using upstream burnman-Major.Minor branch
  • 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
  • Upload new zip file to zenodo, fill in details on website (including new link to ReadTheDocs and github version)
  • Save and publish in zenodo
  • Update GitHub release with new zip files and link to the ReadTheDocs documentation
  • Push release to Pypi (from clean directory, correct branch):
  1. python3 -m pip install --upgrade build
  2. python3 -m build
  3. python3 -m pip install --upgrade twine
  4. python3 -m twine upload --repository testpypi dist/* (to test upload, can get password from the pypi website)
  5. twine upload dist/* (the final upload to Pypi)
  • Merge upstream burnman-Major.Minor branch to master
  • Bump version numbers in pyproject.toml on upstream master to [Major].[Minor+1].0a0
  • Check and update homepage (especially the downloads section for version numbers and the zenodo links)
@bobmyhill bobmyhill added this to the 1.1 milestone Oct 8, 2021
@bobmyhill bobmyhill added this to To do in BurnMan 2 Oct 8, 2021
@bobmyhill bobmyhill moved this from To do to In progress in BurnMan 2 Oct 22, 2021
@bobmyhill bobmyhill moved this from In progress to To do in BurnMan 2 Oct 22, 2021
@bobmyhill bobmyhill modified the milestones: 1.1, 1.2 Sep 21, 2022
@bobmyhill bobmyhill moved this from To do to Done in BurnMan 2 Sep 21, 2022
@bobmyhill bobmyhill moved this from Done to To do in BurnMan 2 Sep 21, 2022
@bobmyhill bobmyhill modified the milestones: 1.2, 1.3 Jul 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant