Skip to content

Commit deb36e2

Browse files
committed
Release checklist: improve information about regenerating the GPG key
Ran into some issues while trying to do this earlier today. Documenting my findings to prevent the same issues when having to do it again next year. I've also asked a question about key rotation in the PHIVE repo to get clarification on some things: phar-io/phar.io 147. This may result in a new PHIVE documentation page about this being available by next year 🤞 It is also the reason why I have not explicitly released the `3.13.1` tag yet as the README does not contain information about the updated GPG key yet. By rights the new key should probably also be mentioned in the changelog, but tags should be immutable, so I'm going to leave that for now. Hopefully this change in the release checklist will prevent this snafu for next year.
1 parent 5296666 commit deb36e2

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

.github/release-checklist.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@
88
- [ ] Verify that any new functions have type declarations (ClassName/array/callable) whenever possible.
99
- [ ] Verify that the license tags all refer to the _new_ organisation and no longer to Squizlabs. (easily overlooked in new files)
1010
- [ ] Verify that `@copyright` tags in new files use `@copyright 20xx PHPCSStandards and contributors`.
11+
- [ ] Check if the GPG key is still valid (not expired).
12+
If it has expired, create a new key before starting the release process.
13+
- Generate a new key following the steps here: <http://phar.io/howto/generate-gpg-key.html>.
14+
- Upload the new key following the steps here: <http://phar.io/howto/uploading-public-keys.html>.
15+
:warning: the command for exporting the key will export _all_ keys for the email address. This will not work as OpenPGP does not send an email to verify the key if the upload contained multiple keys.
16+
So, first run `gpg --keyid-format LONG --list-keys my@email.com`.
17+
Then run `gpg --export --armor KEY_ID > phpcs.pub` specifically for the new key.
18+
And then upload the file.
19+
- Verify the key via the link received via email.
20+
- Update the key information in the README x 3.
21+
- Update the key info in the verify-release GHA workflow x 2.
1122

1223
### Wiki
1324

@@ -77,11 +88,6 @@ Please consider [funding the PHP_CodeSniffer project](http://opencollective.com
7788
gpg -u my@email.com --detach-sign --output phpcs-x.x.x.phar.asc phpcs-x.x.x.phar
7889
gpg -u my@email.com --detach-sign --output phpcbf-x.x.x.phar.asc phpcbf-x.x.x.phar
7990
```
80-
- If, for whatever reason, the key is no longer available or has expired:
81-
-> generate a new key following the steps here: <http://phar.io/howto/generate-gpg-key.html>.
82-
-> upload the new key following the steps here: <http://phar.io/howto/uploading-public-keys.html>.
83-
-> update the key information in the README x 3.
84-
-> update the key info in the verify-release GHA workflow.
8591
- [ ] Get the SHA of the files for the phive.xml file
8692
```bash
8793
# Linux

0 commit comments

Comments
 (0)