From ec13a02dc6f97bc0acac433fd9c859f6fbdba9f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Wed, 6 Nov 2024 09:54:48 +0100 Subject: [PATCH] docs: add release docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- docs/RELEASE.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/RELEASE.md diff --git a/docs/RELEASE.md b/docs/RELEASE.md new file mode 100644 index 0000000..12c0241 --- /dev/null +++ b/docs/RELEASE.md @@ -0,0 +1,35 @@ +# Release docs + +This doc contains information for releasing a new version. + +## Create a release + +Creating a release can be done by pushing a tag to the GitHub repository (beginning with `v`). + +The [release workflow](../../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts. + +```shell +VERSION="v0.0.1" +TAG=$VERSION + +git tag $TAG -m "tag $TAG" -a +git push origin $TAG +``` + +## Publish documentation + +Publishing the documentation for a release is decoupled from cutting a release. + +To publish the documentation push a tag to the GitHub repository (beginning with `docs-v`). + +```shell +VERSION="v0.0.1" +TAG=docs-$VERSION + +git tag $TAG -m "tag $TAG" -a +git push origin $TAG +``` + +## Misc + +- Add to the drop-down list in the bug template