doc: release note setting description (#23)

abema · Mar 9, 2022 · d5ab86a · d5ab86a
1 parent 2a4268b
commit d5ab86a
Showing 1 changed file with 11 additions and 2 deletions.
diff --git 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