From f971b5ca689c80b17cd840a59c9ae56525e25423 Mon Sep 17 00:00:00 2001
From: Rylie Pavlik <rylie.pavlik@collabora.com>
Date: Fri, 7 Jun 2024 15:57:00 -0500
Subject: [PATCH] doc: Update release instructions

Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2242>
---
 doc/how-to-release.md | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/doc/how-to-release.md b/doc/how-to-release.md
index a92001efa..21bba931c 100644
--- a/doc/how-to-release.md
+++ b/doc/how-to-release.md
@@ -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.