diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 000000000000..5c6cc0d2cec5 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,55 @@ +# The overall template of the release notes +template: | + $CHANGES +include-labels: + - 'v2.0.0' + +# Setting the formatting and sorting for the release notes body +name-template: Version $RESOLVED_VERSION Release Notes +change-template: "* $TITLE ([#$NUMBER](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/$NUMBER)) @#AUTHOR" +sort-by: merged_at +sort-direction: ascending +replacers: + - search: '##' + replace: '###' + +# Organizing the tagged PRs into unified categories +categories: + - title: '🚀 Features' + labels: + - 'feature' + - title: '📈 Enhancements' + labels: + - 'enhancement' + - title: '🐛 Bug Fixes' + labels: + - 'bug' + - title: '🚞 Infrastructure' + labels: + - 'build' + - 'ci' + - 'infra' + - 'test' + - 'test:unit' + - 'test:integration' + - 'test:bwc' + - 'test:functional' + - 'dependencies' + - 'github actions' + - 'release' + - title: '🛡 Security' + labels: + - 'cve' + - title: '📝 Documentation' + labels: + - 'docs' + - title: '🛠 Maintenance' + labels: + - 'version compatibility' + - 'maintenance' + - 'versioning' + - 'chore' + - title: '🪛 Refactoring' + labels: + - 'refactor' + - 'code quality' diff --git a/.github/workflows/draft_release_notes_workflow.yml b/.github/workflows/draft_release_notes_workflow.yml new file mode 100644 index 000000000000..bc6cb059a4aa --- /dev/null +++ b/.github/workflows/draft_release_notes_workflow.yml @@ -0,0 +1,17 @@ +name: Release Notes Drafter + +on: + pull_request: + branches: [ '**', '!feature/**' ] + push: + branches: + - main + +jobs: + draft_release_notes: + name: Draft Release Notes + runs-on: ubuntu-latest + steps: + - uses: release-drafter/release-drafter@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}