Skip to content

Commit 10b643d

Browse files
authored
docs: add the 'release process' in README (#7)
Also configure the GitHub auto-generated release notes.
1 parent 615d25c commit 10b643d

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

.github/release.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- chore
5+
- dependencies
6+
categories:
7+
- title: 🎉 New Features
8+
labels:
9+
- enhancement
10+
- title: 🐛 Bug Fixes
11+
labels:
12+
- bug
13+
- title: 📝 Documentation
14+
labels:
15+
- documentation
16+
- title: Other Changes
17+
labels:
18+
- "*"

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,15 @@ Internal tools for bpmn-visualization
66
- [bpmn-rendering-miwg-test-suite](bpmn-rendering-miwg-test-suite/README.md): Generate screenshots of BPMN
77
Diagram rendering of all reference files from the miwg-test-suite project. It helps to publish the results for a given
88
bpmn-visualization version.
9+
10+
11+
## Release process
12+
13+
Go to [GitHub release](https://github.com/process-analytics/bpmn-visualization-tools/releases)
14+
15+
Then
16+
- create a new draft release
17+
- for tag, use **v**x.y.z (do not forget the 'v' prefix)
18+
- for name, same value as tag without the 'v'
19+
- use the auto-generated release notes (do some cleanup if necessary)
20+
- publish to create the git tag and make the release publicly available

0 commit comments

Comments
 (0)