Skip to content

Commit a408874

Browse files
authored
Add release-drafter workflow for generating release notes (benfred#493)
1 parent ef380e5 commit a408874

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

.github/release-drafter.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
categories:
2+
- title: '⚠ Breaking Changes'
3+
labels:
4+
- 'breaking'
5+
- title: '🚀 Features'
6+
labels:
7+
- 'feature'
8+
- 'enhancement'
9+
- title: '🐛 Bug Fixes'
10+
labels:
11+
- 'fix'
12+
- 'bugfix'
13+
- 'bug'
14+
- title: '📄 Documentation'
15+
labels:
16+
- 'documentation'
17+
- title: '🧰 Maintenance'
18+
label:
19+
- 'chore'
20+
- 'ci'
21+
22+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
23+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
24+
version-resolver:
25+
major:
26+
labels:
27+
- 'major'
28+
minor:
29+
labels:
30+
- 'minor'
31+
patch:
32+
labels:
33+
- 'patch'
34+
default: patch
35+
template: |
36+
## Changes
37+
38+
$CHANGES

.github/workflows/release-drafter.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# draft release notes with https://github.com/release-drafter/release-drafter
2+
name: Release Drafter
3+
4+
on:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
update_release_draft:
11+
runs-on: ubuntu-latest
12+
steps:
13+
# Drafts your next Release notes as Pull Requests are merged into "master"
14+
- uses: release-drafter/release-drafter@v5
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Release notes are now being hosted in Github Releases: https://github.com/benfred/py-spy/releases
2+
13
## v0.3.11
24

35
* Update dependencies [#463](https://github.com/benfred/py-spy/pull/463), [#457](https://github.com/benfred/py-spy/pull/463)

0 commit comments

Comments
 (0)