diff options
| author | Heiko Schaefer <heiko@schaefer.name> | 2022-11-07 15:47:36 +0100 |
|---|---|---|
| committer | Heiko Schaefer <heiko@schaefer.name> | 2022-11-07 17:29:56 +0100 |
| commit | a3fb101f056de2cdfa8b9cddd3ac4274fd331291 (patch) | |
| tree | 618104b027232c793cc58b6bce105dd37303d9ae | |
| parent | 59b6c8b04f45403a0a723511a2766e064e40f072 (diff) | |
doc: updates to release checklistheiko/release-checklist
| -rw-r--r-- | doc/release-checklist.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/release-checklist.md b/doc/release-checklist.md index 68e4ed2f..146c9472 100644 --- a/doc/release-checklist.md +++ b/doc/release-checklist.md @@ -1,17 +1,23 @@ This is a checklist for doing Sequoia releases. - 1. Starting from origin/main, create a branch XXX for the release. + 1. Decide which components to release, all subsequent instructions relate to these components. + 1. Decide on the new version number XXX. + 1. Starting from origin/main, create a branch component/XXX for the release. + (Sometimes it's pragmatic to use one branch to release multiple components. That is also ok. Name the branch using your best judgment.) 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. 1. For all 'Cargo.toml's: Bump intra-workspace dependencies if necessary. + 1. Run 'cargo check' (this implicitly updates 'Cargo.lock') + 1. Commit changes to 'Cargo.toml' and 'Cargo.lock' (only the released crates' versions should change in 'Cargo.lock') 1. Update dependencies and run tests. + - Use the exact Rust toolchain version of the current Sequoia MSRV! - 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 update -p backtrace --precise -3.46'. - - Run 'make check'. - - Run 'cargo run -p sequoia-openpgp --example statistics + - Run 'make -f .Makefile check'. + - If releasing sequoia-openpgp, run 'cargo run -p sequoia-openpgp --example statistics --release -- ../sks-dump-*.pgp' and update https://sequoia-pgp.org/tmp/stats.txt . 1. Update manpage for sqv and sq: @@ -22,7 +28,7 @@ This is a checklist for doing Sequoia releases. - Copy man-sq*/*.1 to sequoia/sq/man-sq* - Make a commit with the message "sq, sqv: Update manpage." 1. Make a commit with the message "component: Release XXX.". - - Push this to gitlab, and create a merge request. + - Push this to gitlab, create a merge request, wait for CI. 1. Make a tag component/vXXX with the message "component: Release XXX." signed with an offline-key. 1. Make a clean clone of the repository. @@ -31,7 +37,7 @@ This is a checklist for doing Sequoia releases. 1. In case of errors, correct them, and go back to the step creating the release commit. 1. Merge the branch to main by merging the merge request created in - step 6, push the tag. + step 3, push the tag. 1. Make a source distribution, put it on https://sequoia-pgp.org/dist/, collect and merge signatures. 1. Regenerate docs.sequoia-pgp.org. |