docs: update README

marocchino · Oct 11, 2020 · 9a279aa · 9a279aa
1 parent 061f72b
commit 9a279aa
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -99,6 +99,27 @@ with:
   path: path-to-comment-contents.txt
 ```
 
+### Delete previous commit and add comment at bottom
+
+```yaml
+uses: marocchino/sticky-pull-request-comment@v1
+with:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  recreate: true
+  message: |
+    Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
+```
+
+### Delete previous commit
+
+```yaml
+uses: marocchino/sticky-pull-request-comment@v1
+with:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  delete: true
+```
+
+
 ## Development
 
 Install the dependencies

diff --git a/action.yml b/action.yml
@@ -20,8 +20,9 @@ inputs:
   number:
     description: "pull request number for push event"
     required: false
-  delete: 
+  delete:
     description: "delete the previously created comment"
+    required: false
   GITHUB_TOKEN:
     description: "set secrets.GITHUB_TOKEN here"
     required: true