-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(config): update release-drafter.yml
Updated the Release Drafter configuration file to include: - Categories for features, bug fixes, maintenance, and documentation updates. - Autolabeling using regular expressions to match pull request titles, branch names, and more (e.g., '/feat\\(/i' and '/fix\\(/i'). - A refined template for release notes with a clear and structured format. This enhancement improves the automation and readability of release notes while aligning with repository contribution guidelines.
- Loading branch information
1 parent
a7d3de5
commit 2d428ac
Showing
1 changed file
with
69 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,84 @@ | ||
name-template: 'v$RESOLVED_VERSION' | ||
tag-template: 'v$RESOLVED_VERSION' | ||
template: | | ||
# What's Changed | ||
$CHANGES | ||
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION | ||
|
||
categories: | ||
- title: 'Breaking' | ||
label: 'type: breaking' | ||
- title: 'New' | ||
label: 'type: feature' | ||
- title: 'Bug Fixes' | ||
label: 'type: bug' | ||
- title: 'Maintenance' | ||
label: 'type: maintenance' | ||
- title: 'Fixes' | ||
labels: | ||
- 'fix' | ||
- 'bugfix' | ||
- 'bug' | ||
- title: 'Refactoring' | ||
labels: | ||
- 'refactor' | ||
- 'refactoring' | ||
- title: 'Documentation' | ||
label: 'type: docs' | ||
- title: 'Other changes' | ||
- title: 'Dependency Updates' | ||
label: 'type: dependencies' | ||
labels: | ||
- 'docs' | ||
- 'documentation' | ||
- title: 'Features' | ||
labels: | ||
- 'feat' | ||
- 'feature' | ||
- 'enhancement' | ||
- title: 'Maintenance' | ||
labels: | ||
- 'chore' | ||
- 'maintenance' | ||
collapse-after: 5 | ||
|
||
autolabeler: | ||
- label: 'docs' | ||
files: | ||
- '*.md' | ||
branch: | ||
- /docs\/.+/' | ||
title: | ||
- '/docs/\(/i' | ||
- label: 'bug' | ||
branch: | ||
- '/fix\/.+/' | ||
- '/Hotfix\/.+/' | ||
title: | ||
- '/fix/\(/i' | ||
- label: 'enhancement' | ||
branch: | ||
- '/feature\/.+/' | ||
title: | ||
- '/feature/\(/i' | ||
- '/feat/\(/i' | ||
- label: 'chore' | ||
branch: | ||
- '/chore\/.+/' | ||
title: | ||
- '/chore/\(/i' | ||
- label: 'refactor' | ||
branch: | ||
- '/refactor\/.+/' | ||
title: | ||
- '/refactor/\(/i' | ||
|
||
|
||
|
||
version-resolver: | ||
major: | ||
labels: | ||
- 'type: breaking' | ||
- 'major' | ||
minor: | ||
labels: | ||
- 'type: feature' | ||
- 'minor' | ||
patch: | ||
labels: | ||
- 'type: bug' | ||
- 'type: maintenance' | ||
- 'type: docs' | ||
- 'type: dependencies' | ||
- 'type: security' | ||
- 'patch' | ||
default: patch | ||
|
||
|
||
template: | | ||
## Description | ||
This release marks the full release of version v$RESOLVED_VERSION with significant improvements and additions. Key changes include bug fixes, refactoring, updated documentation, new features, and maintenance updates. | ||
## What's Changed | ||
exclude-labels: | ||
- 'skip-changelog' | ||
$CHANGES | ||
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION |