The open source OpenXR runtime
doc: Add HOWTO release document
+48
+48
doc/howto-release.md
+48
doc/howto-release.md
···
1
+
# How to release
2
+
3
+
These instructions assumes that the version you are making is `21.0.0`.
4
+
5
+
## Generate changelog
6
+
7
+
Run proclamation in the `doc/changes`.
8
+
9
+
```sh
10
+
proclamation build 21.0.0 --delete-fragments --overwrite
11
+
```
12
+
13
+
Commit changes, split in two commits to help unrolling or editing changes.
14
+
15
+
```sh
16
+
git commit -m"doc: Update CHANGELOG.md" doc/CHANGELOG.md
17
+
git commit -m"doc: Remove old changelog fragments" doc/changes
18
+
```
19
+
20
+
21
+
## Update versions
22
+
23
+
Edit the files
24
+
25
+
* `CMakelists.txt`
26
+
* `meson.build`
27
+
* `src/xrt/state_trackers/oxr/oxr_instance.c`
28
+
29
+
See previous commits for exact places.
30
+
31
+
```sh
32
+
git commit -a -m"monado: Update version"
33
+
```
34
+
35
+
36
+
## Tag the code
37
+
38
+
Do the tagging from git, do **not** do it from gitlab, also make sure to prefix
39
+
the version with `v` so that `21.0.0` becomes `v21.0.0`.
40
+
41
+
```sh
42
+
git tag v21.0.0 -m"v21.0.0"
43
+
```
44
+
45
+
46
+
## Do gitlab release
47
+
48
+
The Gitlab UI has a friendly interface, just follow the guide there.