Skip to content

Commit

Permalink
docs: add GitHub release changelog configuration (#229)
Browse files Browse the repository at this point in the history
This PR adds a GitHub release configuration, which should simplify
changelog generation.
  • Loading branch information
MegaRedHand authored Jan 17, 2025
1 parent dc2fff6 commit 5b2b850
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Fixes #

### What Changed?
<!-- Describe the changes made in this pull request -->

### Reviewer Checklist

- [ ] New features are tested and documented
- [ ] PR has one of the `changelog-X` labels (if applies)
- [ ] Code deprecates any old functionality before removing it
33 changes: 33 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
changelog:
exclude:
labels:
- ignore-for-release
categories:
# vulnerabilities
- title: Security πŸ”’
labels:
- changelog-security
# new features
- title: Added πŸŽ‰
labels:
- changelog-added
# changes in existing functionality
- title: Changed πŸ› 
labels:
- changelog-changed
# soon-to-be removed features
- title: Deprecated ⚠️
labels:
- changelog-deprecated
# now removed features
- title: Removed πŸ—‘
labels:
- changelog-removed
# documentation was added or changed
- title: Documentation πŸ“š
labels:
- changelog-documentation

- title: Other Changes
labels:
- "*"

0 comments on commit 5b2b850

Please sign in to comment.