mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-26 17:37:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Update release instructions

Browse source 
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2242>
This commit is contained in:
Rylie Pavlik 2024-06-07 15:57:00 -05:00
parent 1874683137
commit f971b5ca68
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc/how-to-release.md
View file

@ -5,45 +5,45 @@ Copyright 2021, Collabora, Ltd. and the Monado contributors
SPDX-License-Identifier: BSL-1.0
-->
These instructions assumes that the version you are making is `21.0.0`.
These instructions assumes that the version you are making is `24.0.0`.
## Generate changelog
Run proclamation in the `doc/changes`.
```sh
proclamation build 21.0.0 --delete-fragments --overwrite
proclamation build 24.0.0
```
Commit changes, split in two commits to help unrolling or editing changes.
Commit changes.
```sh
git commit -m"doc: Update CHANGELOG.md" doc/CHANGELOG.md
git commit -m"doc: Remove old changelog fragments" doc/changes
git commit -m "doc: Update CHANGELOG" doc/CHANGELOG.md doc/changes
```
## Update versions
Edit the files
Edit the files below to update the version number embedded in them.
* `CMakelists.txt`
* `src/xrt/state_trackers/oxr/oxr_instance.c`
* `CMakeLists.txt`
* `vcpkg.json`
See previous commits for exact places.
```sh
git commit -a -m"monado: Update version"
git commit -m "monado: Update version" CMakeLists.txt vcpkg.json
```
## Tag the code
Do the tagging from git, do **not** do it from gitlab, also make sure to prefix
the version with `v` so that `21.0.0` becomes `v21.0.0`.
Do the tagging from git, do **not** do it from GitLab.
Also, make sure to prefix the version with `v` so that e.g. `24.0.0` becomes `v24.0.0`.
The `-s` flag signs the tag.
```sh
git tag v21.0.0 -m"v21.0.0"
git tag v24.0.0 -m "v24.0.0" -a -s
```
## Do gitlab release
## Do GitLab release
The Gitlab UI has a friendly interface, follow the guide there.
The GitLab UI has a friendly interface, follow the guide there.