Skip to content

Commit

Permalink
create config and workflow files for release note (#209)
Browse files Browse the repository at this point in the history
Signed-off-by: Xun Zhang <xunzh@amazon.com>
  • Loading branch information
Zhangxunmt authored Mar 11, 2022
1 parent 1d30a22 commit 133b380
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/draft-release-notes-config.yml
Original file line number Diff line number Diff line change
@@ -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"
20 changes: 20 additions & 0 deletions .github/workflows/draft-release-notes-workflow.yml
Original file line number Diff line number Diff line change
@@ -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 }}

0 comments on commit 133b380

Please sign in to comment.