Skip to content

make_a_release.rst

Latest commit

 

History

History
67 lines (37 loc) · 1.7 KB

make_a_release.rst

File metadata and controls

67 lines (37 loc) · 1.7 KB

Making a release

A core developer should use the following steps to create a release X.Y.Z of cmake-python-distributions on PyPI.

This is usually done after :ref:`updating_cmake_version`.

Prerequisites

PyPI: Step-by-step

  1. Make sure that all CI tests are passing on GitHub Actions.
  2. Download the latest sources if you don't already have them
$ git clone git@github.com:scikit-build/cmake-python-distributions
$ cd cmake-python-distributions
  1. Ask nox for the instructions on what to type
$ nox -s tag_release
  1. Run the suggested lines, probably something like this:
$ git tag --sign -m 'cmake-python-distributions 3.31.10' 3.31.10 main
$ git push origin 3.31.10

Warning

We recommend using a GPG signing key to sign the tag.

  1. Check the status of the builds on GitHub Actions.
  2. Once the builds are completed, check that the distributions are available on PyPI.
  3. Make a GitHub release based on the tag. This will display the latest version in the GitHub sidebar, and will notify release watchers of the release. Title it Version X.Y.Z and add a little note about what changed (Python only).