Skip to content

Commit c4ad3bc

Browse files
rgommersdnicolodi
authored andcommitted
DOC/REL: update docs on how release tags are signed
We've used PGP signing for releases to date, with the exact keys published in the docs. Unfortunately that has poor usability, and sets an expectation that takes work and doc updates to keep - for very little extra real-world protection. So drop that going forward, and instead explain how to check signing. Also amend the 0.21.0 Changelog entry for this change, and fix the release date in the Changelog while we're at it.
1 parent e6107e4 commit c4ad3bc

3 files changed

Lines changed: 27 additions & 28 deletions

File tree

‎CHANGELOG.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ Changelog
2222
build errors when rebuilding.
2323
- Use ``.start`` files (PEP 829) instead of ``.pth`` files to implement editable
2424
wheels for Python 3.15 and later.
25+
- From this release onwards, SSH keys used to sign release tags.
2526

26-
Daniele Nicolodi, Michał Górny, Ralf Gommers --- 25-08-2026.
27+
Daniele Nicolodi, Michał Górny, Ralf Gommers --- 07-09-2026.
2728

2829

2930
0.20.0

‎RELEASE.rst‎

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,11 @@
55
Release Process
66
===============
77

8-
All releases are PGP signed with one of the keys listed in ``docs/about.rst``.
9-
Before releasing please make sure your PGP key is listed there, and preferably
10-
signed by one of the other key holders.
8+
Releases are published as git tags, signed with either an SSH or a PGP key
9+
belonging to a maintainer. The signing key must be registered on GitHub so that
10+
GitHub shows the tag as verified.
1111

12-
If your key is not signed by one of the other key holders, please make sure
13-
that the PR that added your key to ``docs/about.rst`` was approved by at least
14-
one other maintainer.
15-
16-
After that is done, you may release the project by following these steps:
12+
You may release the project by following these steps:
1713

1814
#. Release to the Git repository on GitHub:
1915

@@ -23,36 +19,31 @@ After that is done, you may release the project by following these steps:
2319
#. Create ``CHANGELOG.rst`` section for the new release and fill it.
2420
#. The commit message should read: ``REL: set version to X.Y.Z``
2521

26-
#. Create a GPG-signed tag for the release:
22+
#. Create a signed tag for the release:
2723

2824
.. code-block:: console
2925
3026
$ git tag -s X.Y.Z
3127
32-
The tag title should follow the ``meson-python X.Y.Z`` format, and the
33-
tag body should be a plain text version of the change-log for the current
34-
release.
35-
36-
#. Push the commit and tag to the repository:
28+
This signs with your PGP key by default. To sign with an SSH key instead,
29+
configure git once beforehand:
3730

3831
.. code-block:: console
3932
40-
$ git push
41-
$ git push --tags
42-
43-
#. Release to PyPI:
33+
$ git config --global gpg.format ssh
34+
$ git config --global user.signingkey ~/.ssh/id_ed25519.pub
4435
45-
#. Build the Python artifacts:
36+
The SSH signing key must be registered on
37+
GitHub as a Signing Key for the tag to show as verified.
4638

47-
.. code-block:: console
48-
49-
$ python -m build
39+
The tag title should follow the ``meson-python X.Y.Z`` format, and the
40+
tag body should be a plain text version of the change-log for the current
41+
release.
5042

51-
#. Push the artifacts to PyPI:
43+
#. Push the tag to the repository:
5244

5345
.. code-block:: console
5446
55-
$ twine upload dist/*
47+
$ git push --tags
5648
57-
There is no need to GPG-sign the artifacts: PyPI no longer
58-
supports uploading GPG signatures.
49+
#. Release to PyPI is done via trusted publishing, triggering on the tag.

‎docs/about.rst‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,20 @@ supported Python versions.
4949

5050
Distributors are recommended to fetch release sources from the
5151
corresponding tags on the Git repository_ or from source distributions
52-
on `PyPI`_. Git tags are PGP-signed with one of the following keys:
52+
on `PyPI`_. From ``0.21.0`` onwards, releases are published as signed tags,
53+
signed with either an SSH or a PGP key belonging to `@rgommers`_ or
54+
`@dnicolodi`_. Those signing keys can be retrieved from GitHub.
55+
56+
Releases up to and including ``0.20.0`` are PGP-signed with one of the
57+
following keys:
5358

5459
- |3DCE51D60930EBA47858BA4146F633CBB0EB4BF2|_ Filipe Laíns
5560
- |52BDC33FD1FBAB569D47FFA923D9E5499A08BDC5|_ Ralf Gommers
5661

5762
.. _repository: https://github.com/mesonbuild/meson-python
5863
.. _PyPI: https://pypi.org/project/meson-python/
64+
.. _@rgommers: https://github.com/rgommers
65+
.. _@dnicolodi: https://github.com/dnicolodi
5966

6067
.. |3DCE51D60930EBA47858BA4146F633CBB0EB4BF2| replace:: ``3DCE51D60930EBA47858BA4146F633CBB0EB4BF2``
6168
.. _3DCE51D60930EBA47858BA4146F633CBB0EB4BF2: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3dce51d60930eba47858ba4146f633cbb0eb4bf2

0 commit comments

Comments
 (0)