From c85540eebfaf522fc1215e1b36038f837932ab7b Mon Sep 17 00:00:00 2001 From: tzaeschke Date: Thu, 19 Feb 2026 17:46:41 +0100 Subject: [PATCH 1/2] howto --- ReleaseHowTo.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 ReleaseHowTo.md diff --git a/ReleaseHowTo.md b/ReleaseHowTo.md new file mode 100644 index 0000000..c692578 --- /dev/null +++ b/ReleaseHowTo.md @@ -0,0 +1,62 @@ + + + + +https://github.com/tzaeschke/phtree-cpp/releases/v1.6.2/download/v1.6.2.tar.gz + + +## Create Release + + +### GitHub + +Create release. + + +### Archive + +```bash +git archive --format=zip v1.6.2 > phtree-cpp-v1.6.2.zip +``` + +Upload to GitHub release. + +Resulting link: +``` +https://github.com/tzaeschke/phtree-cpp/releases/download/v1.6.2/phtree-cpp-v1.6.2.zip +``` + + +### Bazel Central Repository + +Documentation: +https://github.com/bazelbuild/bazel-central-registry/blob/main/docs/README.md + + +#### Start + +Checkout personal fork of bazel-central-registry. +Create branch phtree-cpp@1.6.2 + +#### After modifying any file + +Recreate hashes for `source.json` +```shell +bazel run -- //tools:update_integrity phtree-cpp +``` + This also accepts `--version` but defaults to latest version. + +#### Validate + +```shell +bazel run -- //tools:bcr_validation --check=phtree-cpp@1.6.2 +``` + +#### Test locally + +```bash +bazel run //tools:setup_presubmit_repos -- --module phtree-cpp@1.6.2 +``` + +There is also a GitHub action for release automation: +https://github.com/bazel-contrib/publish-to-bcr \ No newline at end of file From 0f450097a3264f1be212ee8fa1373e0ab5836abb Mon Sep 17 00:00:00 2001 From: tzaeschke Date: Sun, 22 Feb 2026 19:24:23 +0100 Subject: [PATCH 2/2] Release instructions --- .bazelignore | 1 + ReleaseHowTo.md | 41 ++++++++++++++++++++++++++++++++++------- 2 files changed, 35 insertions(+), 7 deletions(-) diff --git a/.bazelignore b/.bazelignore index 9c6ed55..b4ebead 100644 --- a/.bazelignore +++ b/.bazelignore @@ -4,3 +4,4 @@ out cmake-build-debug third_party +.clwb \ No newline at end of file diff --git a/ReleaseHowTo.md b/ReleaseHowTo.md index c692578..47aaeaf 100644 --- a/ReleaseHowTo.md +++ b/ReleaseHowTo.md @@ -5,15 +5,27 @@ https://github.com/tzaeschke/phtree-cpp/releases/v1.6.2/download/v1.6.2.tar.gz -## Create Release +# Create Release -### GitHub +## Verify code -Create release. +### Run examples +```shell +bazel run //examples:example +``` + +### Test release with +- test-phtree-cpp-bazel +- test-phtree-cpp-cmake +### Compilers -### Archive +- Test with gcc + clang on Linux +- Test with VisualStudio on Windows +- Update references of tested compilers in README.md + +## Create Archive ```bash git archive --format=zip v1.6.2 > phtree-cpp-v1.6.2.zip @@ -27,16 +39,21 @@ https://github.com/tzaeschke/phtree-cpp/releases/download/v1.6.2/phtree-cpp-v1.6 ``` -### Bazel Central Repository +## Bazel Central Repository -- Unfinished documentation Documentation: https://github.com/bazelbuild/bazel-central-registry/blob/main/docs/README.md +PH-Tree build target: +``` +bazel build //:phtree +``` + #### Start Checkout personal fork of bazel-central-registry. -Create branch phtree-cpp@1.6.2 +Create branch `phtree-cpp@1.6.2`. #### After modifying any file @@ -59,4 +76,14 @@ bazel run //tools:setup_presubmit_repos -- --module phtree-cpp@1.6.2 ``` There is also a GitHub action for release automation: -https://github.com/bazel-contrib/publish-to-bcr \ No newline at end of file +https://github.com/bazel-contrib/publish-to-bcr + + +#### Test with Test repos + +Check out `test-phtree-cpp-bazel` and run: + +```shell +bazel shutdown && bazel build --enable_bzlmod --registry="file:///home/.../bazel-central-registry" --lockfile_mode=off @phtree-cpp//:phtree-cpp +--> Target might be incorrect +``` \ No newline at end of file