From 2d428acd633c829e4c7158a21891ce1d633ca284 Mon Sep 17 00:00:00 2001 From: JRocabruna <43208985+JRocabruna@users.noreply.github.com> Date: Fri, 15 Nov 2024 12:05:21 +0100 Subject: [PATCH] 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. --- .github/release-drafter.yml | 96 ++++++++++++++++++++++++++----------- 1 file changed, 69 insertions(+), 27 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index af22748..00d2160 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -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