From c37af9c1ffa0d369eda319b920ced5f29baa5c41 Mon Sep 17 00:00:00 2001 From: PSeitz-dd Date: Fri, 22 Aug 2025 01:57:48 +0200 Subject: [PATCH] update release instructions (#2687) --- RELEASE.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index d2ee79851..39bede476 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,4 +1,4 @@ -# Release a new Tantivy Version +# Releasing a new Tantivy Version ## Steps @@ -10,12 +10,29 @@ 6. Set git tag with new version -In conjucation with `cargo-release` Steps 1-4 (I'm not sure if the change detection works): -Set new packages to version 0.0.0 +[`cargo-release`](https://github.com/crate-ci/cargo-release) will help us with steps 1-5: Replace prev-tag-name ```bash -cargo release --workspace --no-publish -v --prev-tag-name 0.19 --push-remote origin minor --no-tag --execute +cargo release --workspace --no-publish -v --prev-tag-name 0.24 --push-remote origin minor --no-tag ``` -no-tag or it will create tags for all the subpackages +`no-tag` or it will create tags for all the subpackages + +cargo release will _not_ ignore unchanged packages, but it will print warnings for them. +e.g. "warning: updating ownedbytes to 0.10.0 despite no changes made since tag 0.24" + +We need to manually ignore these unchanged packages +```bash +cargo release --workspace --no-publish -v --prev-tag-name 0.24 --push-remote origin minor --no-tag --exclude tokenizer-api +``` + +Add `--execute` to actually publish the packages, otherwise it will only print the commands that would be run. + +### Tag Version +```bash +git tag 0.25.0 +git push upstream tag 0.25.0 +``` + +