Skip to content

Release process

Guillaume Fraux edited this page Sep 3, 2024 · 5 revisions

Here is how to release a new version of sphericart

  1. pick the new version number according to semantic versionning
  2. update the version number in the VERSION file, commit and push this change
  3. tag the repository with the new version number e.g. git tag v0.42.1 and push the tag git push --tags
    • this will create a new version of the docs on readthedocs
  4. activate the new version of the docs on readthedocs: https://readthedocs.org/projects/sphericart/versions/
  5. wait for the CI to build the wheels: in the list of jobs, look for the the "Build Python wheels" job running for your new tag.
    • this will automatically create a release for this tag, and attach the build wheels to the release
    • the release creation will automatically update the version archived on zenodo
  6. update the description of the github release for this tag, including the main user-facing changes
  7. download the wheels and sdist from the release on your computer
  8. test the wheels locally: they should install, import and run fine.
  9. upload wheels to PyPI with twine upload <all-release-files-here> (pip install twine). You might need to login to your PyPI account with twine first. This is definitive and can not be undone!
Clone this wiki locally