Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 1.36 KB

RELEASE.rst

File metadata and controls

30 lines (26 loc) · 1.36 KB

How to make a new release of orix

Create a PR to the master branch and go through the following steps.

Preparation

  • Review the contributor list __credits__ in orix/__init__.py to ensure all contributors are included and sorted correctly.
  • Bump __version__ in orix/__init__.py, for example to "0.8.2".
  • Update the changelog CHANGELOG.rst.
  • Let the PR collect comments for a day to ensure that other maintainers are comfortable with releasing. Merge.

Release (and tag)

  • Create a tagged, annotated (meaning with a release text) with the name v0.8.2" and title "orix 0.8.2". The tag target will be the master branch. Draw inspiration from previous release texts. Publish the release.
  • Monitor the publish GitHub Action to ensure the release is successfully published to PyPI.

Post-release action

  • Monitor the documentation build to ensure that the new stable documentation is successfully built from the release.
  • Make a post-release PR to master with __version__ updated (or reverted), e.g. to "0.9.dev0", and any updates to this guide if necessary.
  • Tidy up GitHub issues and close the corresponding milestone.
  • A PR to the conda-forge feedstock will be created by the conda-forge bot.