The open source OpenXR runtime
doc: Update release instructions
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2242>
+14
-14
+14
-14
doc/how-to-release.md
+14
-14
doc/how-to-release.md
···
5
5
SPDX-License-Identifier: BSL-1.0
6
6
-->
7
7
8
-
These instructions assumes that the version you are making is `21.0.0`.
8
+
These instructions assumes that the version you are making is `24.0.0`.
9
9
10
10
## Generate changelog
11
11
12
12
Run proclamation in the `doc/changes`.
13
13
14
14
```sh
15
-
proclamation build 21.0.0 --delete-fragments --overwrite
15
+
proclamation build 24.0.0
16
16
```
17
17
18
-
Commit changes, split in two commits to help unrolling or editing changes.
18
+
Commit changes.
19
19
20
20
```sh
21
-
git commit -m"doc: Update CHANGELOG.md" doc/CHANGELOG.md
22
-
git commit -m"doc: Remove old changelog fragments" doc/changes
21
+
git commit -m "doc: Update CHANGELOG" doc/CHANGELOG.md doc/changes
23
22
```
24
23
25
24
## Update versions
26
25
27
-
Edit the files
26
+
Edit the files below to update the version number embedded in them.
28
27
29
-
* `CMakelists.txt`
30
-
* `src/xrt/state_trackers/oxr/oxr_instance.c`
28
+
* `CMakeLists.txt`
29
+
* `vcpkg.json`
31
30
32
31
See previous commits for exact places.
33
32
34
33
```sh
35
-
git commit -a -m"monado: Update version"
34
+
git commit -m "monado: Update version" CMakeLists.txt vcpkg.json
36
35
```
37
36
38
37
## Tag the code
39
38
40
-
Do the tagging from git, do **not** do it from gitlab, also make sure to prefix
41
-
the version with `v` so that `21.0.0` becomes `v21.0.0`.
39
+
Do the tagging from git, do **not** do it from GitLab.
40
+
Also, make sure to prefix the version with `v` so that e.g. `24.0.0` becomes `v24.0.0`.
41
+
The `-s` flag signs the tag.
42
42
43
43
```sh
44
-
git tag v21.0.0 -m"v21.0.0"
44
+
git tag v24.0.0 -m "v24.0.0" -a -s
45
45
```
46
46
47
-
## Do gitlab release
47
+
## Do GitLab release
48
48
49
-
The Gitlab UI has a friendly interface, follow the guide there.
49
+
The GitLab UI has a friendly interface, follow the guide there.