From 133b38071ad87ff2f313f7fba446888c8704977b Mon Sep 17 00:00:00 2001 From: Xun Zhang Date: Fri, 11 Mar 2022 13:24:02 -0800 Subject: [PATCH] create config and workflow files for release note (#209) Signed-off-by: Xun Zhang --- .github/draft-release-notes-config.yml | 45 +++++++++++++++++++ .../draft-release-notes-workflow.yml | 20 +++++++++ 2 files changed, 65 insertions(+) create mode 100644 .github/draft-release-notes-config.yml create mode 100644 .github/workflows/draft-release-notes-workflow.yml diff --git a/.github/draft-release-notes-config.yml b/.github/draft-release-notes-config.yml new file mode 100644 index 0000000000..f6f0c2b67c --- /dev/null +++ b/.github/draft-release-notes-config.yml @@ -0,0 +1,45 @@ +# The overall template of the release notes +template: | + Compatible with OpenSearch (**set version here**). + $CHANGES +# Setting the formatting and sorting for the release notes body +name-template: Version (set version here) +change-template: "* $TITLE ([#$NUMBER]($URL))" +sort-by: merged_at +sort-direction: ascending +replacers: + - search: "##" + replace: "###" + +# Organizing the tagged PRs into unified ODFE categories +categories: + - title: "Breaking changes" + labels: + - "breaking change" + - title: "Features" + labels: + - "feature" + - title: "Enhancements" + labels: + - "enhancement" + - title: "Bug Fixes" + labels: + - "bug" + - "bug fix" + - title: "Infrastructure" + labels: + - "infra" + - "test" + - "dependencies" + - "github actions" + - title: "Documentation" + labels: + - "documentation" + - title: "Maintenance" + labels: + - "version upgrade" + - "odfe release" + - 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 0000000000..5e67f9a5ab --- /dev/null +++ b/.github/workflows/draft-release-notes-workflow.yml @@ -0,0 +1,20 @@ +name: Release Drafter + +on: + push: + branches: + - main + +jobs: + update_release_draft: + name: Update draft release notes + runs-on: ubuntu-latest + steps: + - name: Update draft release notes + uses: release-drafter/release-drafter@v5 + with: + config-name: draft-release-notes-config.yml + name: Version (set here) + tag: (None) + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}