From 9a279aa9fa0f28839f71634c4de251ffc2262d54 Mon Sep 17 00:00:00 2001 From: marocchino Date: Mon, 12 Oct 2020 08:31:08 +0900 Subject: [PATCH] docs: update README --- README.md | 21 +++++++++++++++++++++ action.yml | 3 ++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ad786d2..9f0a7e4 100644 --- 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 +``` + +### 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 index 16754ea..f62f7f5 100644 --- 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