From 99e09987f84a424f21fd334ed8c4bfff5a58dc81 Mon Sep 17 00:00:00 2001 From: Brieuc Loussouarn <32448554+bloussou@users.noreply.github.com> Date: Thu, 29 Aug 2024 16:27:42 +0200 Subject: [PATCH] doc: improve release doc --- content/docs/guides/release/index.en.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/guides/release/index.en.md b/content/docs/guides/release/index.en.md index 67fa482a9..de98aede9 100644 --- a/content/docs/guides/release/index.en.md +++ b/content/docs/guides/release/index.en.md @@ -13,8 +13,8 @@ The process for creating a new release is as follows: - `git switch staging && git pull` 1. Create a git **annotated** tag - We are using the [semantic versioning](https://semver.org/) - - `git tag -a vx.y.z` (most of the time use the latest version and increment the patch version) - - `git push --tags vx.y.z` + - `git tag -a vx.y.z` with the message `Release x.y.z` (most of the time use the latest version and increment the patch version) + - `git push --tags` 1. Create a github release - Draft a new github release [here](https://github.com/OpenRailAssociation/osrd/releases/new) - Select the created tag