Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.15 KB

releasing_guide.md

File metadata and controls

31 lines (23 loc) · 1.15 KB

Cut a Release

Create a PR to the RELEASE_next_patch branch and go through the following steps:

Preparation

  • Bump version in hyperspy/Release.py
  • Update and check changelog in CHANGES.rst: run towncrier build (to preview, run towncrier build --draft)
  • (optional) check conda-forge and wheels build. Pushing a tag to a fork will run the release workflow without uploading to pypi
  • Let that PR collect comments for a day to ensure that other maintainers are comfortable with releasing

Tag and release ⚠️ this is a point of no return point ⚠️

  • push tag (vx.y.z) to the upstream repository and the following will be triggered:
    • creation of a zenodo record and the mining of a DOI
    • creation of a Github Release
    • build of the wheels and their upload to pypi
    • update of the current version on readthedocs to this release

Post-release action

  • Increment the version and set it back to dev: vx.y.z.dev0
  • Update version in other branches when necessary
  • Merge the PR

Follow-up

  • Tidy up and close corresponding milestone
  • A PR to the conda-forge feedstock will be created by the conda-forge bot