Skip to content

Commit 7be133c

Browse files
committed
Add Release Drafter configuration for automated release notes
1 parent 922e4ff commit 7be133c

File tree

2 files changed

+121
-0
lines changed

2 files changed

+121
-0
lines changed

.github/release-drafter.yml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
4+
5+
categories:
6+
- title: '💥 Breaking changes'
7+
labels:
8+
- ':boom: breaking change'
9+
- title: '🚀 New Features'
10+
labels:
11+
- ':rocket: feature'
12+
- title: '👻 Bug Fixes'
13+
labels:
14+
- ':ghost: bug'
15+
- title: '⏳ Deprecations'
16+
labels:
17+
- ':file_cabinet: deprecation'
18+
- title: '📃 Documentation'
19+
labels:
20+
- ':book: documentation'
21+
- title: '🧰 Maintenance'
22+
labels:
23+
- ':building_construction: build'
24+
- ':construction_worker_woman: ci'
25+
collapse-after: 5
26+
- title: '🔬 Other updates'
27+
labels:
28+
- ':nail_care: style'
29+
- ':test_tube: testing'
30+
- ':racing_car: performance'
31+
- ':sparkles: code quality'
32+
- ':sparkles: enhancement'
33+
- title: '🧩 Dependency Updates'
34+
labels:
35+
- ':recycle: dependencies'
36+
collapse-after: 5
37+
exclude-labels:
38+
- ':arrow_up: bump'
39+
- 'skip-changelog'
40+
41+
autolabeler:
42+
- label: ':rocket: feature'
43+
title:
44+
- '/adds/i'
45+
- '/add method/i'
46+
- label: ':ghost: bug'
47+
title:
48+
- '/fix/i'
49+
- label: ':sparkles: code quality'
50+
title:
51+
- '/Refactor/i'
52+
- label: ':test_tube: testing'
53+
files:
54+
- 'test_*'
55+
- 'conftest.py'
56+
- label: ':book: documentation'
57+
title:
58+
- '/docs:/i'
59+
files:
60+
- '*.md'
61+
- 'mkdocs.yml'
62+
- label: ':construction_worker_woman: ci'
63+
files:
64+
- '.github/*'
65+
- label: ':recycle: dependencies'
66+
title:
67+
- '/bump/i'
68+
- label: ':file_cabinet: deprecation'
69+
title:
70+
- '/Deprecate/i'
71+
72+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
73+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
74+
exclude-contributors:
75+
- 'dependabot'
76+
77+
version-resolver:
78+
major:
79+
labels:
80+
- ':boom: breaking change'
81+
minor:
82+
labels:
83+
- ':rocket: feature'
84+
default: patch
85+
86+
template: |
87+
## What's Changed
88+
89+
$CHANGES
90+
91+
Contributors: $CONTRIBUTORS
92+
93+
replacers:
94+
- search: '/(?:and )?@dependabot(?:\[bot\])?,?/g'
95+
replace: ''

.github/workflows/draft.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# pull_request event is required only for autolabeler
8+
pull_request:
9+
types: [opened, reopened, synchronize]
10+
pull_request_target:
11+
types: [opened, reopened, synchronize]
12+
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
update-draft:
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: write
21+
pull-requests: write
22+
steps:
23+
# Drafts your next Release notes as Pull Requests are merged into "main"
24+
- uses: release-drafter/release-drafter@v6
25+
env:
26+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)