From d5ab86aa12b10074d4589275a8a78912fb49deed Mon Sep 17 00:00:00 2001 From: 0daryo <38380837+0daryo@users.noreply.github.com> Date: Wed, 9 Mar 2022 17:55:53 +0900 Subject: [PATCH] doc: release note setting description (#23) --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3951fde..057071c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # github-actions-merger -github-actions-merger is github actions that merges pull request with commit message including pull request labels. +github-actions-merger is github actions that merges pull request with commit message including pull request labels and release-note block. ## Usage 1. Write your workflow file. @@ -17,12 +17,21 @@ github-actions-merger is github actions that merges pull request with commit mes https://github.com/abema/github-actions-merger/blob/main/.github/workflows/github-actions-merger.yaml 2. comment ```/merge``` on github pull request comment. +PullRequest body can include release-note block. -3. pull request is merged, and commit message includes labels. +e.g. +```release-note +Breaking change! +``` + +3. pull request is merged, and commit message includes labels and release-note block. ``` fix: readme +Labels: * documentation * enhancement +release-note: +* Breaking change! ``` ## Parameters