aboutsummaryrefslogtreecommitdiff
path: root/docs/releasing.md
blob: cdf415997ae67e373b80de0f4f498dee59b98337 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# How to release

* Make sure you're on main and synced to HEAD
* Ensure the project builds and tests run
    * `parallel -j0 exec ::: test/*_test` can help ensure everything at least
      passes
* Prepare release notes
    * `git log $(git describe --abbrev=0 --tags)..HEAD` gives you the list of
      commits between the last annotated tag and HEAD
    * Pick the most interesting.
* Create one last commit that updates the version saved in `CMakeLists.txt`, `MODULE.bazel`
  and the `__version__` variable in `bindings/python/google_benchmark/__init__.py`to the
  release version you're creating. (This version will be used if benchmark is installed
  from the archive you'll be creating in the next step.)

```
project (benchmark VERSION 1.8.0 LANGUAGES CXX)
```

```
module(name = "com_github_google_benchmark", version="1.8.0")
```

```python
# bindings/python/google_benchmark/__init__.py

# ...

__version__ = "1.8.0"  # <-- change this to the release version you are creating

# ...
```

* Create a release through github's interface
    * Note this will create a lightweight tag.
    * Update this to an annotated tag:
      * `git pull --tags`
      * `git tag -a -f <tag> <tag>`
      * `git push --force --tags origin`
* Confirm that the "Build and upload Python wheels" action runs to completion
    * run it manually if it hasn't run