Publish

Publishing a new version

Publication to PyPI is automated via GitHub actions. The workflow is triggered by version tags.

• Make sure all documentation is up-to-date: re-run and commit the example notebooks which serve as documentation.
  The notebooks are not automatically re-run during deployment!
• Update the version string in xplt/__init__.py (including trailing zeros)
• Push and make sure all checks pass (CI failures will not prevent releasing to PyPI!)
• Create a tag in the form v0.0.0 with matching version number (including trailing zeros).
  This can conveniently be done by creating a release on GitHub.
  Make sure the tag version exactly matches the version string in xplt/__init__.py
• When the tag is created, the release action (see release.yaml) will be triggered and
  • check that the tag matches the version string
  • publish the package to test.pypi.org
  • build the documentation and push it to the gh-pages branch, from where it is published on GitHub Pages
  • publish the package to pypi.org