-
Notifications
You must be signed in to change notification settings - Fork 4
Publish
Philipp Niedermayer edited this page Apr 16, 2024
·
23 revisions
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
- 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 inxplt/__init__.py
- When the tag is created, the release action will be triggered and automatically publish the package to PyPI and documentation to GitHub Pages