Skip to content

Commit e73c345

Browse files
committed
Add automated release notes
1 parent 2032a87 commit e73c345

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

.github/pull_request_template.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
**What this PR does / why we need it**:
2+
3+
**Which issue(s) this PR fixes**:
4+
Fixes #
5+
6+
**Special notes for your reviewer**:
7+
8+
**Release note**:
9+
<!-- Write your release note:
10+
1. Enter your release note in the below block.
11+
2. If no release note is required, just write "NONE" within the block.
12+
13+
Format of block header: <category> <target_group>
14+
Possible values:
15+
- category: breaking|feature|bugfix|doc|other
16+
- target_group: user|operator|developer|dependency
17+
-->
18+
```feature user
19+
20+
```

.github/workflows/release.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,40 @@ jobs:
6464
git tag -a "${{ env.version }}" -m "Release ${{ env.version }}"
6565
git push origin "${{ env.version }}"
6666
67+
- name: Build Changelog
68+
id: github_release
69+
uses: mikepenz/release-changelog-builder-action@v5
70+
with:
71+
mode: "PR"
72+
configurationJson: |
73+
{
74+
"template": "#{{CHANGELOG}}",
75+
"pr_template": "- #{{TITLE}}: ##{{NUMBER}}",
76+
"categories": [
77+
{
78+
"title": "## Feature",
79+
"labels": ["feat", "feature"]
80+
},
81+
{
82+
"title": "## Fix",
83+
"labels": ["fix", "bug"]
84+
},
85+
{
86+
"title": "## Other",
87+
"labels": []
88+
}
89+
],
90+
"label_extractor": [
91+
{
92+
"pattern": "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\\([\\w\\-\\.]+\\))?(!)?: ([\\w ])+([\\s\\S]*)",
93+
"on_property": "title",
94+
"target": "$1"
95+
}
96+
]
97+
}
98+
env:
99+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
100+
67101
- name: Create GitHub release
68102
if: ${{ env.SKIP != 'true' }}
69103
uses: softprops/action-gh-release@v2

0 commit comments

Comments
 (0)