xref: /aosp_15_r20/external/cronet/third_party/google_benchmark/src/docs/releasing.md (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1# How to release
2
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`, `MODULE.bazel`
12  and the `__version__` variable in `bindings/python/google_benchmark/__init__.py`to the
13  release version you're creating. (This version will be used if benchmark is installed
14  from the archive you'll be creating in the next step.)
15
16```
17project (benchmark VERSION 1.8.0 LANGUAGES CXX)
18```
19
20```
21module(name = "com_github_google_benchmark", version="1.8.0")
22```
23
24```python
25# bindings/python/google_benchmark/__init__.py
26
27# ...
28
29__version__ = "1.8.0"  # <-- change this to the release version you are creating
30
31# ...
32```
33
34* Create a release through github's interface
35    * Note this will create a lightweight tag.
36    * Update this to an annotated tag:
37      * `git pull --tags`
38      * `git tag -a -f <tag> <tag>`
39      * `git push --force --tags origin`
40* Confirm that the "Build and upload Python wheels" action runs to completion
41    * run it manually if it hasn't run
42