matrixfurry.com
The open source OpenXR runtime
1# How to make a release {#how-to-release}
2
3<!--
4Copyright 2021, Collabora, Ltd. and the Monado contributors
5SPDX-License-Identifier: BSL-1.0
6-->
7
8These instructions assumes that the version you are making is `24.0.0`.
9
10## Generate changelog
11
12Run proclamation in the `doc/changes`.
13
14```sh
15proclamation build 24.0.0
16```
17
18Commit changes.
19
20```sh
21git commit -m "doc: Update CHANGELOG" doc/CHANGELOG.md doc/changes
22```
23
24## Update versions
25
26Edit the files below to update the version number embedded in them.
27
28* `CMakeLists.txt`
29* `vcpkg.json`
30
31See previous commits for exact places.
32
33```sh
34git commit -m "monado: Update version" CMakeLists.txt vcpkg.json
35```
36
37## Tag the code
38
39Do the tagging from git, do **not** do it from GitLab.
40Also, make sure to prefix the version with `v` so that e.g. `24.0.0` becomes `v24.0.0`.
41The `-s` flag signs the tag.
42
43```sh
44git tag v24.0.0 -m "v24.0.0" -a -s
45```
46
47## Do GitLab release
48
49The GitLab UI has a friendly interface, follow the guide there.