aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/blake3/tools/release.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2025-11-07 14:49:13 +0100
committerGitHub Enterprise <[email protected]>2025-11-07 14:49:13 +0100
commit24e43a913f29ac3b314354e8ce5175f135bcc64f (patch)
treeca442937ceeb63461012b33a4576e9835099f106 /thirdparty/blake3/tools/release.md
parentget oplog attachments (#622) (diff)
downloadzen-24e43a913f29ac3b314354e8ce5175f135bcc64f.tar.xz
zen-24e43a913f29ac3b314354e8ce5175f135bcc64f.zip
switch to xmake for package management (#611)
This change removes our dependency on vcpkg for package management, in favour of bringing some code in-tree in the `thirdparty` folder as well as using the xmake build-in package management feature. For the latter, all the package definitions are maintained in the zen repo itself, in the `repo` folder. It should now also be easier to build the project as it will no longer depend on having the right version of vcpkg installed, which has been a common problem for new people coming in to the codebase. Now you should only need xmake to build. * Bumps xmake requirement on github runners to 2.9.9 to resolve an issue where xmake on Windows invokes cmake with `v144` toolchain which does not exist * BLAKE3 is now in-tree at `thirdparty/blake3` * cpr is now in-tree at `thirdparty/cpr` * cxxopts is now in-tree at `thirdparty/cxxopts` * fmt is now in-tree at `thirdparty/fmt` * robin-map is now in-tree at `thirdparty/robin-map` * ryml is now in-tree at `thirdparty/ryml` * sol2 is now in-tree at `thirdparty/sol2` * spdlog is now in-tree at `thirdparty/spdlog` * utfcpp is now in-tree at `thirdparty/utfcpp` * xmake package repo definitions is in `repo` * implemented support for sanitizers. ASAN is supported on windows, TSAN, UBSAN, MSAN etc are supported on Linux/MacOS though I have not yet tested it extensively on MacOS * the zencore encryption implementation also now supports using mbedTLS which is used on MacOS, though for now we still use openssl on Linux * crashpad * bumps libcurl to 8.11.0 (from 8.8.0) which should address a rare build upload bug
Diffstat (limited to 'thirdparty/blake3/tools/release.md')
-rw-r--r--thirdparty/blake3/tools/release.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/thirdparty/blake3/tools/release.md b/thirdparty/blake3/tools/release.md
new file mode 100644
index 000000000..26c492723
--- /dev/null
+++ b/thirdparty/blake3/tools/release.md
@@ -0,0 +1,16 @@
+# 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.
+ - Bump the dependency version too, if new features are used.
+- Delete b3sum/Cargo.lock and recreate it with `cargo build` or similar.
+- Update the `-h` output in b3sum/README.md if it's changed.
+- Bump `BLAKE3_VERSION_STRING` in c/blake3.h.
+- Bump `VERSION` in c/CMakeLists.txt.
+- 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` in b3sum/.