[Infra] Fix version-check workflow (#100090)
[llvm-project.git] / third-party / benchmark / docs / releasing.md
blob09bf93764d009d0723a8a724144d1bd15c4cd1bb
1 # How to release
3 * Make sure you're on main and synced to HEAD
4 * Ensure the project builds and tests run
5     * `parallel -j0 exec ::: test/*_test` can help ensure everything at least
6       passes
7 * Prepare release notes
8     * `git log $(git describe --abbrev=0 --tags)..HEAD` gives you the list of
9       commits between the last annotated tag and HEAD
10     * Pick the most interesting.
11 * Create one last commit that updates the version saved in `CMakeLists.txt` and `MODULE.bazel`
12   to the release version you're creating. (This version will be used if benchmark is installed
13   from the archive you'll be creating in the next step.)
15 ```
16 project (benchmark VERSION 1.8.0 LANGUAGES CXX)
17 ```
19 ```
20 module(name = "com_github_google_benchmark", version="1.8.0")
21 ```
23 * Create a release through github's interface
24     * Note this will create a lightweight tag.
25     * Update this to an annotated tag:
26       * `git pull --tags`
27       * `git tag -a -f <tag> <tag>`
28       * `git push --force --tags origin`
29 * Confirm that the "Build and upload Python wheels" action runs to completion
30     * Run it manually if it hasn't run.
31     * IMPORTANT: When re-running manually, make sure to select the newly created `<tag>` as the workflow version in the "Run workflow" tab on the GitHub Actions page.