Skip to content

Commit 35c8e06

Browse files
authored
Adding the release drafter, for release note generation (#2368)
1 parent 50fab03 commit 35c8e06

File tree

3 files changed

+72
-11
lines changed

3 files changed

+72
-11
lines changed

.github/release-drafter-config.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name-template: '$NEXT_MINOR_VERSION'
2+
tag-template: 'v$NEXT_MINOR_VERSION'
3+
autolabeler:
4+
- label: 'maintenance'
5+
files:
6+
- '*.md'
7+
- '.github/*'
8+
- label: 'bug'
9+
branch:
10+
- '/bug-.+'
11+
- label: 'maintenance'
12+
branch:
13+
- '/maintenance-.+'
14+
- label: 'feature'
15+
branch:
16+
- '/feature-.+'
17+
categories:
18+
- title: 'Breaking Changes'
19+
labels:
20+
- 'breakingchange'
21+
- title: '🧪 Experimental Features'
22+
labels:
23+
- 'experimental'
24+
- title: '🚀 New Features'
25+
labels:
26+
- 'feature'
27+
- 'enhancement'
28+
- title: '🐛 Bug Fixes'
29+
labels:
30+
- 'fix'
31+
- 'bugfix'
32+
- 'bug'
33+
- 'BUG'
34+
- title: '🧰 Maintenance'
35+
label: 'maintenance'
36+
change-template: '- $TITLE (#$NUMBER)'
37+
exclude-labels:
38+
- 'skip-changelog'
39+
template: |
40+
# Changes
41+
42+
$CHANGES
43+
44+
## Contributors
45+
We'd like to thank all the contributors who worked on this release!
46+
47+
$CONTRIBUTORS
48+

.github/workflows/commitlint.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

.github/workflows/release-drafter.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
# branches to consider in the event; optional, defaults to all
6+
branches:
7+
- master
8+
9+
permissions: {}
10+
jobs:
11+
update_release_draft:
12+
permissions:
13+
pull-requests: write # to add label to PR (release-drafter/release-drafter)
14+
contents: write # to create a github release (release-drafter/release-drafter)
15+
16+
runs-on: ubuntu-latest
17+
steps:
18+
# Drafts your next Release notes as Pull Requests are merged into "master"
19+
- uses: release-drafter/release-drafter@v5
20+
with:
21+
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
22+
config-name: release-drafter-config.yml
23+
env:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)