Release procedure

This wiki contains notes on how to release a new version of the twoaxistracking package.

Step 1. Finalize pull request:

• Update the whatsnew file
  • Add/edit release date and version
  • Check that all links and references render correctly
• Update version number in setup.cfg
• Merge the pull request

Step 2. Make release tag to upload the new version to PyPI

• Create a git tag e.g., v0.2.1. The title is the version name and has to start with "v" for the workflow to be activated.
• The description of the tag should be a link to the whatsnew file for the specific release, e.g., https://twoaxistracking.readthedocs.io/en/v0.2.1/whatsnew.html
• Once the tag has been created, GitHub actions will build the package and push it to PyPI.
• Check that the GitHub action was successfully completed
• Verify that everything was successful by pip installing the package