Publish

Publishing a new version

Publication to PyPI is automated via GitHub actions and triggered via merging to the main branch

Please make sure the example notebooks used for documentation are up-to-date, since they are deployed as-is.

Bugfix release procedure

• Have a PR into main for which
  • The bugfix number of the __version__ string in xplt/__init__.py is incremented
  • CI passes
• Merge the PR 🚀
• Update the GitHub release to mention the bugfix

Minor and major release procedure

• Have a PR into main for which
  • The minor or major number of the __version__ string in xplt/__init__.py is incremented
  • CI passes
• Create a branch fix-* from main for future bug fixing of the previous version
• Merge the PR 🚀
• Create a GitHub release documenting the changes and additions to the previous version

Information

🚀 Merging a PR into main will trigger CI to do the following:

• CI creates a matching tag via the Release trigger workflow
• CI builds and publishes the package to test.pypi.org
• CI builds the documentation and pushes it to the gh-pages branch, from where it is published on GitHub Pages
• CI publishes the package to pypi.org