diff options
| author | Jack O'Connor <oconnor663@gmail.com> | 2022-01-25 11:47:49 -0500 |
|---|---|---|
| committer | Jack O'Connor <oconnor663@gmail.com> | 2022-01-25 12:02:56 -0500 |
| commit | 15447749ef8086c1e7124e682cf1edffdb7bf217 (patch) | |
| tree | b8004dbd32a910f5e3f330862e60755e10ee76e8 /tools | |
| parent | 540f708a94e1a50e20d6dbf6921a59560645f342 (diff) | |
add a release checklist
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/release.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/tools/release.md b/tools/release.md new file mode 100644 index 0000000..5c1f67e --- /dev/null +++ b/tools/release.md @@ -0,0 +1,15 @@ +# Release checklist + +- Make sure `cargo outdated -R` is clean in the root and in b3sum/. +- Bump the version in the root Cargo.toml. +- Bump the version in b3sum/Cargo.toml. +- Delete b3sum/Cargo.lock and recreate it with `cargo build` or similar. +- Update the `--help` output (including the version number) in b3sum/README.md. +- Bump `BLAKE3_VERSION_STRING` in c/blake3.h. +- Make a version bump commit with change notes. +- `git push` and make sure CI is green. +- `git tag` the version bump commit with the new version number. +- `git push --tags` +- `cargo publish` in the root. +- `cargo publish --dry-run` in b3sum/ and make sure it fetches the just-published library version. +- `cargo publish` in b3sum/. |