Skip to content

Latest commit

 

History

History
58 lines (50 loc) · 3.06 KB

RELEASE.rst

File metadata and controls

58 lines (50 loc) · 3.06 KB
Raw

How to make a new release of kikuchipy

kikuchipy's branching model is similar to the Gitflow Workflow (original blog post).

  • If a minor release is to be made, create a release branch v<major>.<minor>.0 off of the develop branch locally. If a patch release is to be made, create a release branch v<major>.<minor>.<patch> off of the main branch locally instead. Ideally, a patch release should be made immediately after a bug fix has been made. Therefore, it might be best to do the release updates, listed in the following steps, directly on the bug fix branch, so that no separate patch release branch has to be made. The bug fix branch should of course be branched off of main.
  • Increment the version number in release.py. Review and clean up CHANGELOG.rst as per Keep a Changelog. Make sure all contributors and reviewers are acknowledged.
  • Make a PR of the release branch to main. Discuss the changelog with others, and make any changes directly to the release branch. Merge the branch into main. Then make a PR of main to develop, and merge this.
  • If the __version__ in release.py on main has changed in a new commit, a tagged, annotated release draft is automatically created. If __version__ is now "0.42.0", the release name is "kikuchipy 0.42.0", and the tag name is "v0.42.0". The tag target will be the main branch. The release body contains a static description and a link to the changelog. This release draft can be published as is, or changes to the release body can be made before publishing.
  • Monitor the publish GitHub Action to ensure the release is successfully published to PyPI.
  • Download the new version from PyPI with the dev dependencies with pip install kikuchipy[dev]==0.42.0 locally and run the tests with pytest --pyargs kikuchipy to make sure everything is as it should be.
  • Make a PR to develop with any updates to this guide if necessary.

conda-forge

A kikuchipy build recipe is available at https://github.com/conda-forge/kikuchipy-feedstock. conda-forge documentation is available at https://conda-forge.org/docs/index.html.

  • Normally, a conda-forge bot will make a PR to the feedstock with the necessary changes within a day of a new PyPI release, to our great convenience!
  • Proceed with the last steps below.

If the bot for some reason does not make this PR:

  • Fork the feedstock.
  • Create a local release branch named v<major>.<minor>.x off of master.
  • Increment the version number in recipe/meta.yml. Get the SHA256 for the package distribution (.tar.gz) from PyPI https://pypi.org/project/kikuchipy/.
  • Make a PR to master from your release branch.
  • Proceed with the last steps below.

Last steps:

  • Follow the relevant instructions from the conda-forge documentation on updating packages, as well as the instructions in the PR, and merge it after all checks are green.
  • Monitor the Azure pipeline CI to ensure the release is successfully published to conda-forge.