Skip to content

Commit 34f0d15

Browse files
committed
ci: Release Drafter
1 parent ca24cb7 commit 34f0d15

File tree

2 files changed

+98
-0
lines changed

2 files changed

+98
-0
lines changed

.github/release-drafter.yml

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# .github/release-drafter.yml
2+
# The default template for your release notes
3+
name-template: 'v$NEXT_PATCH_VERSION' # E.g., v1.0.1, v1.1.0
4+
5+
tag-template: 'v$NEXT_PATCH_VERSION'
6+
7+
# Define sections for different types of changes
8+
template: |
9+
## What's Changed
10+
11+
$CHANGES
12+
13+
## New Features ✨
14+
$FEATURES
15+
16+
## Bug Fixes 🐛
17+
$BUGS
18+
19+
## Enhancements & Refinements 🚀
20+
$ENHANCEMENTS
21+
22+
## Breaking Changes ⚠️
23+
$BREAKING_CHANGES
24+
25+
## Other Changes
26+
$OTHERS
27+
28+
# Categorize pull requests based on labels
29+
categories:
30+
- title: 'New Features ✨'
31+
labels:
32+
- 'feature'
33+
- 'feat'
34+
- 'new-feature'
35+
collapse-after: 5 # Collapse this section if there are more than 5 items
36+
template: |
37+
- {{TITLE}} (#{{NUMBER}})
38+
39+
- title: 'Bug Fixes 🐛'
40+
labels:
41+
- 'bug'
42+
- 'fix'
43+
template: |
44+
- {{TITLE}} (#{{NUMBER}})
45+
46+
- title: 'Enhancements & Refinements 🚀'
47+
labels:
48+
- 'enhancement'
49+
- 'refinement'
50+
- 'improve'
51+
template: |
52+
- {{TITLE}} (#{{NUMBER}})
53+
54+
- title: 'Breaking Changes ⚠️'
55+
labels:
56+
- 'breaking-change'
57+
- 'breaking'
58+
template: |
59+
- **BREAKING:** {{TITLE}} (#{{NUMBER}})
60+
61+
- title: 'Other Changes'
62+
labels:
63+
- 'dependencies'
64+
- 'chore'
65+
- 'docs'
66+
- 'ci'
67+
- 'build'
68+
- 'refactor'
69+
template: |
70+
- {{TITLE}} (#{{NUMBER}})
71+
72+
# Exclude certain labels from showing up in the notes
73+
exclude-labels:
74+
- 'skip-changelog' # Use this label on PRs you don't want in release notes
75+
- 'duplicate'
76+
- 'invalid'
77+
78+
# How to identify the target branch for the next release (useful for pre-releases)
79+
# This will create a 'Next' release when you push to main and no pre-release is active
80+
# If you want to draft a release based on the latest stable tag, you might omit this.
81+
# configuration-language: json
82+
# Here we're using a simple versioning scheme that bumps the patch version.
83+
# You can customize this extensively.
84+
version-template: $MAJOR.$MINOR.$PATCH
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
update_release_draft:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: release-drafter/release-drafter@v5
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)