diff options
author | Nora Widdecke <nora@sequoia-pgp.org> | 2021-04-16 12:04:55 +0200 |
---|---|---|
committer | Nora Widdecke <nora@sequoia-pgp.org> | 2021-04-16 12:05:26 +0200 |
commit | 6194d546f39b1201571b8d263bc11ba7f064f4d6 (patch) | |
tree | 5d9fea0c78650b8f5094e188f61af546ae8134a0 | |
parent | c40098830eae1ddaa8907fdaf38ad371acc77198 (diff) |
doc: Use ordered list.
- Ordered lists are rendered correctly, regardless of the numbers
used in the source.
- This makes it easier to follow the instructions.
-rw-r--r-- | doc/release-checklist.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/release-checklist.md b/doc/release-checklist.md index 225ac490..e4e65138 100644 --- a/doc/release-checklist.md +++ b/doc/release-checklist.md @@ -1,12 +1,12 @@ This is a checklist for doing Sequoia releases. - - Starting from origin/main, create a branch XXX for the release. - - For all 'Cargo.toml's: Bump version = "XXX". + 1. Starting from origin/main, create a branch XXX for the release. + 1. For all 'Cargo.toml's: Bump version = "XXX". - Only do this for non-released crates and those with changes relative to the last released version. - - For all 'Cargo.toml's: Bump documentation = "https://.../XXX/...". - - For all 'Cargo.toml's: Bump intra-workspace dependencies. - - Update dependencies and run tests. + 1. For all 'Cargo.toml's: Bump documentation = "https://.../XXX/...". + 1. For all 'Cargo.toml's: Bump intra-workspace dependencies. + 1. Update dependencies and run tests. - Run 'cargo update' to update the dependencies. If some dependency is updated and breaks due to our MSRV, find a good version of that dependency and select it using e.g. 'cargo @@ -15,31 +15,31 @@ This is a checklist for doing Sequoia releases. - Run 'cargo run -p sequoia-openpgp --example statistics --release -- ../sks-dump-*.pgp' and update https://sequoia-pgp.org/tmp/stats.txt . - - Update manpage for sqv and sq: + 1. Update manpage for sqv and sq: - Clone https://gitlab.com/sequoia-pgp/manpage-maker to a separate location. - Add symlinks and run as described in the manpage-maker's readme - Copy man-sqv/sqv.1 to sequoia/sqv/man-sqv/sqv.1 - Copy man-sq*/*.1 to sequoia/sq/man-sq* - Make a commit with the message "sq, sqv: Update manpage." - - Make a commit with the message "Release XXX.". + 1. Make a commit with the message "Release XXX.". - Push this to gitlab, and create a merge request. - - Make a tag vXXX with the message "Release XXX." signed with an + 1. Make a tag vXXX with the message "Release XXX." signed with an offline-key. - - Make a clean clone of the repository. - - For the following crates, cd into the directory, and do 'cargo + 1. Make a clean clone of the repository. + 1. For the following crates, cd into the directory, and do 'cargo publish': - buffered-reader - openpgp - sqv - - In case of errors, correct them, and go back to the step creating + 1. In case of errors, correct them, and go back to the step creating the release commit. - - Merge the branch to main by merging the merge request created in + 1. Merge the branch to main by merging the merge request created in step 6, push the tag. - - Make a source distribution, put it on + 1. Make a source distribution, put it on https://sequoia-pgp.org/dist/, collect and merge signatures. - - Regenerate docs.sequoia-pgp.org. - - Announce the release. + 1. Regenerate docs.sequoia-pgp.org. + 1. Announce the release. - IRC - mailing list - web site |