Publish

Publishing a new version

Publication to PyPI is automated via GitHub actions.

Make sure the example notebooks used for documentation are up-to-date, since they are deployed as-is
Update the __version__ string in xplt/__init__.py to e.g. 0.1.0 or 0.2.4-rc1, see here for formats
Create a PR into main
When releasing a major or minor version: Create a branch main-* from main for future bug fixing of the previous version (e.g. main-1.2 when releasing 1.3.0)

Merge the PR 🚀
Add/update the GitHub release
- For major or minor releases, create a new GitHub release documenting the changes and additions since the previous version
- For bugfixes and release-candidates updates, edit the existing GitHub release (update notes and associated tag)
~~CI creates a matching tag via the Release trigger workflow~~
⚠ This automatism is temporarily disabled, please trigger it manually or create a tag manually or via a GitHub release. The tag must be of the form "v" + version string from xplt/__init__.py.
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