Skip to content

RELEASE.rst

Latest commit

 

History

History
49 lines (31 loc) · 1.47 KB

RELEASE.rst

File metadata and controls

49 lines (31 loc) · 1.47 KB
Raw

Release Process

Releases are published as git tags, signed with either an SSH or a PGP key belonging to a maintainer. The signing key must be registered on GitHub so that GitHub shows the tag as verified.

You may release the project by following these steps:

  1. Release to the Git repository on GitHub:

    1. Create the release commit

      1. Bump the versions in pyproject.toml and in mesonpy/__init__.py.
      2. Create CHANGELOG.rst section for the new release and fill it.
      3. The commit message should read: REL: set version to X.Y.Z

    2. Create a signed tag for the release:

      $ git tag -s X.Y.Z

      This signs with your PGP key by default. To sign with an SSH key instead, configure git once beforehand:

      $ git config --global gpg.format ssh
$ git config --global user.signingkey ~/.ssh/id_ed25519.pub

      The SSH signing key must be registered on GitHub as a Signing Key for the tag to show as verified.

      The tag title should follow the meson-python X.Y.Z format, and the tag body should be a plain text version of the change-log for the current release.

    3. Push the tag to the repository:

      $ git push --tags

  2. Release to PyPI is done via trusted publishing, triggering on the tag.