From b5d1d708b01f86294a0d55f9fd1ca4613a06b451 Mon Sep 17 00:00:00 2001 From: Mindaugas Laganeckas Date: Mon, 9 Sep 2024 14:58:01 +0200 Subject: [PATCH] Document release procedure --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ef6c703e..5e14eab3 100644 --- a/README.md +++ b/README.md @@ -228,3 +228,14 @@ it installs (`mmdc`). `npx -p @mermaid-js/mermaid-cli mmdc -h` ## For contributors Contributions are welcome. See the [contribution guide](CONTRIBUTING.md). + +## Release procedure + +### When +Normally, we make releases, when a new version of mermaid is published. Unless we need to make an emergency fix and we cannot wait for the next mermaid release. +### How +Click on the [Releases](https://github.com/mermaid-js/mermaid-cli/releases). You will find a draft of the next release (there must at lease 1 contribution). From here: +1. Create a tag with the release version, e.g. 11.1.1. Normally, we follow mermaid project release version. +2. Release name is the version of the release tag, e.g. 11.1.1. +3. Update the draft if needed +4. Publish the release. That's it! You are done.