mirror of
https://github.com/marocchino/sticky-pull-request-comment.git
synced 2025-12-12 11:41:14 +00:00
docs: update README
This commit is contained in:
parent
061f72bd8f
commit
9a279aa9fa
2 changed files with 23 additions and 1 deletions
21
README.md
21
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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in a new issue