Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document release procedure #743

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document release procedure #743

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, sorry, I just realized what file this was in.

Could we move this documentation to a different file? Maybe a new file in the docs/ folder?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem! I will move it :)

Original file line number Diff line number Diff line change
Expand Up @@ -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.