Skip to content

Commit ddb75f6

Browse files
committed
docs: add release-drafter for populating GitHub releases info based on the PRs
1 parent d4c8c33 commit ddb75f6

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

.github/release-drafter.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# See https://github.com/release-drafter/release-drafter#configuration-options
2+
name-template: 'v$RESOLVED_VERSION'
3+
tag-template: 'v$RESOLVED_VERSION'
4+
# Filter previous releases to consider only those with the target matching the current branch
5+
filter-by-commitish: true
6+
tag-prefix: REL
7+
exclude-labels:
8+
- 'skip-changelog'
9+
categories:
10+
- title: '🚀 Features'
11+
labels:
12+
- 'feature'
13+
- 'enhancement'
14+
- title: '🐛 Bug Fixes'
15+
labels:
16+
- 'fix'
17+
- 'bugfix'
18+
- 'bug'
19+
- 'defect'
20+
- title: '📝 Documentation'
21+
labels:
22+
- 'documentation'
23+
- title: '🧰 Maintenance'
24+
label: 'chore'
25+
- title: '⬆️ Dependencies'
26+
collapse-after: 8
27+
labels:
28+
- 'dependencies'
29+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
30+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
31+
version-resolver:
32+
major:
33+
labels:
34+
- 'major'
35+
minor:
36+
labels:
37+
- 'minor'
38+
patch:
39+
labels:
40+
- 'patch'
41+
default: patch
42+
template: |
43+
## Changes
44+
45+
$CHANGES
46+
# See https://github.com/release-drafter/release-drafter#autolabeler
47+
# This is more like a reference, since auto-labelling PRs seems to require too much privileges
48+
autolabeler:
49+
- label: 'dependencies'
50+
files:
51+
- 'gradle-wrapper.properties'
52+
title:
53+
- '/^fix\(deps\)/i'
54+
- '/^chore:\s*bump/i'
55+
- label: 'chore'
56+
files:
57+
- '*gradle*'
58+
branch:
59+
- '/docs{0,1}\/.+/'
60+
title:
61+
- '/^chore/i'
62+
- label: 'documentation'
63+
files:
64+
- '*.md'
65+
- 'docs/**'
66+
- label: 'bug'
67+
branch:
68+
- '/fix\/.+/'
69+
title:
70+
- '/^fix/i'
71+
- label: 'enhancement'
72+
branch:
73+
- '/feature\/.+/'
74+
title:
75+
- '/^feat/i'

.github/workflows/release-drafter.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
- 'release/**'
9+
# pull_request_target allows PR from forks to access secrets, so please NEVER add pull_request_target
10+
11+
jobs:
12+
update_release_draft:
13+
# Skip release drafts in forks
14+
if: github.repository_owner == 'apache'
15+
name: Update Release Draft
16+
runs-on: ubuntu-latest
17+
steps:
18+
# Drafts your next Release notes as Pull Requests are merged into "master"
19+
- name: Update release body draft
20+
uses: release-drafter/release-drafter@569eb7ee3a85817ab916c8f8ff03a5bd96c9c83e # v5
21+
id: prepare_release
22+
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
23+
with:
24+
# config-name: my-config.yml
25+
disable-autolabeler: true
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

xdocs/changes.xml

+1
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ Summary
101101

102102
<ch_section>Non-functional changes</ch_section>
103103
<ul>
104+
<li><pr>6000</pr>Add release-drafter for populating GitHub releases info based on the merged PRs</li>
104105
</ul>
105106

106107
<!-- =================== Bug fixes =================== -->

0 commit comments

Comments
 (0)