How to do a release to PyPi (pip)

Plottrs continuous integration is setup to automatically create a new release and upload it to pypi when a tag of the right type is created. The steps needed to do a release are outlined below:

1. Update the readme with all important changes from the last release
2. Ensure that manual tests are passing. The pytest powered tests are tested in Github actions and must always pass. However, Plottr ships a number of manual tests that can be run with tests\run_gui_test.py. Before doing a release you should ensure that these work correctly.
3. Github release the package.
   • go to Tags->Releases->New Draft, copy changelog into the description, give the release a title that is consistent with previous releases, use v as a tag (notice the v; for example, v0.8.0).
   • Save as draft
   • Make sure that CI passes on the current master branch. Re-run the pipeline if you're in doubt.
   • Click publish to publish the release
4. Verify that the Upload Python Package action executes correctly and the package is uploaded to PyPi