matrixfurry.com / monado
The open source OpenXR runtime
fork atom
monado / doc / how-to-release.md
at prediction 976 B view raw view code
Rylie Pavlik doc: Update release instructions
f971b5ca

How to make a release {#how-to-release}#

These instructions assumes that the version you are making is 24.0.0.

Generate changelog#

Run proclamation in the doc/changes.

proclamation build 24.0.0

Commit changes.

git commit -m "doc: Update CHANGELOG" doc/CHANGELOG.md doc/changes

Update versions#

Edit the files below to update the version number embedded in them.

  • CMakeLists.txt
  • vcpkg.json

See previous commits for exact places.

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 e.g. 24.0.0 becomes v24.0.0. The -s flag signs the tag.

git tag v24.0.0 -m "v24.0.0" -a -s

Do GitLab release#

The GitLab UI has a friendly interface, follow the guide there.