summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2021-10-05 16:12:16 +0200
committerJustus Winter <justus@sequoia-pgp.org>2021-10-05 16:12:16 +0200
commit5ac996e83c22af2fed714d6b2e9138c2c9ba6451 (patch)
treee5b4f77ad94d15f14decdec639e375172ab73924
parentc7f1a82028eecda12231390e76ebd9d8bdf14882 (diff)
doc: Update release checklist.
-rw-r--r--doc/release-checklist.md22
1 files changed, 9 insertions, 13 deletions
diff --git a/doc/release-checklist.md b/doc/release-checklist.md
index e4e65138..68e4ed2f 100644
--- a/doc/release-checklist.md
+++ b/doc/release-checklist.md
@@ -4,8 +4,7 @@ This is a checklist for doing Sequoia releases.
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 documentation = "https://.../XXX/...".
- 1. For all 'Cargo.toml's: Bump intra-workspace dependencies.
+ 1. For all 'Cargo.toml's: Bump intra-workspace dependencies if necessary.
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
@@ -22,22 +21,19 @@ This is a checklist for doing Sequoia releases.
- 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."
- 1. Make a commit with the message "Release XXX.".
+ 1. Make a commit with the message "component: Release XXX.".
- Push this to gitlab, and create a merge request.
- 1. Make a tag vXXX with the message "Release XXX." signed with an
- offline-key.
+ 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.
- 1. For the following crates, cd into the directory, and do 'cargo
- publish':
- - buffered-reader
- - openpgp
- - sqv
+ 1. For the crate to be published, cd into the directory, and do
+ 'cargo publish'.
1. In case of errors, correct them, and go back to the step creating
- the release commit.
+ the release commit.
1. Merge the branch to main by merging the merge request created in
- step 6, push the tag.
+ step 6, push the tag.
1. Make a source distribution, put it on
- https://sequoia-pgp.org/dist/, collect and merge signatures.
+ https://sequoia-pgp.org/dist/, collect and merge signatures.
1. Regenerate docs.sequoia-pgp.org.
1. Announce the release.
- IRC