actions/marocchino-sticky-pull-request-comment
2
0
Fork 0
mirror of https://github.com/marocchino/sticky-pull-request-comment.git synced 2025-12-13 12:11:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README

Browse source
This commit is contained in:
marocchino 2020-10-12 08:31:08 +09:00
parent 061f72bd8f
commit 9a279aa9fa
No known key found for this signature in database
GPG key ID: AFF521DBDB122570
2 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -99,6 +99,27 @@ with:
path: path-to-comment-contents.txt 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 ## Development
Install the dependencies Install the dependencies

3
action.yml
View file

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