summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2021-04-06 15:19:39 +0200
committerJustus Winter <justus@sequoia-pgp.org>2021-04-06 15:25:46 +0200
commit5a3d26552a0b2b8622290f8ed487d9bd758404bc (patch)
tree184661aa673673220523b2429c9315ecf14bc9f2
parenta5abce4506832d3a95a3ace9ad44aa774af4ed2d (diff)
doc: Use unordered list.
-rw-r--r--doc/release-checklist.md33
1 files changed, 17 insertions, 16 deletions
diff --git a/doc/release-checklist.md b/doc/release-checklist.md
index bc19865c..6d92119d 100644
--- a/doc/release-checklist.md
+++ b/doc/release-checklist.md
@@ -1,39 +1,40 @@
This is a checklist for doing Sequoia releases.
- 0. Starting from origin/main, create a branch XXX for the release.
- 1. For all 'Cargo.toml's: Bump version = "XXX".
+ - Starting from origin/main, create a branch XXX for the release.
+ - 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.
- 2. For all 'Cargo.toml's: Bump documentation = "https://.../XXX/...".
- 3. For all 'Cargo.toml's: Bump intra-workspace dependencies.
- 4. Run 'make sanity-check-versions'.
+ - For all 'Cargo.toml's: Bump documentation = "https://.../XXX/...".
+ - For all 'Cargo.toml's: Bump intra-workspace dependencies.
+ - Run 'make sanity-check-versions'.
- This simple check fails if not all versions are in sync.
- 5. Update dependencies and run tests.
+ - 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
- update -p backtrace --precise 0.3.46'.
+ update -p backtrace --precise -3.46'.
- Run 'make check'.
- Run 'cargo run -p sequoia-openpgp --example statistics
--release -- ../sks-dump-*.pgp' and update
https://sequoia-pgp.org/tmp/stats.txt .
- 6. Make a commit with the message "Release XXX.".
+ - Make a commit with the message "Release XXX.".
- Push this to gitlab, and create a merge request.
- 7. Make a tag vXXX with the message "Release XXX." signed with an
+ - Make a tag vXXX with the message "Release XXX." signed with an
offline-key.
- 8. Make a clean clone of the repository.
- 9. For the following crates, cd into the directory, and do 'cargo
+ - Make a clean clone of the repository.
+ - For the following crates, cd into the directory, and do 'cargo
publish':
- buffered-reader
- openpgp
- sqv
-10. In case of errors, correct them, and go back to 6.
-11. Merge the branch to main by merging the merge request created in
+ - 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
step 6, push the tag.
-12. Make a source distribution, put it on
+ - Make a source distribution, put it on
https://sequoia-pgp.org/dist/, collect and merge signatures.
-13. Regenerate docs.sequoia-pgp.org.
-14. Announce the release.
+ - Regenerate docs.sequoia-pgp.org.
+ - Announce the release.
- IRC
- mailing list
- web site