Explain delete a bit more (#372)

* Explain `delete` a bit more

* Apply suggestions from code review

Co-authored-by: marocchino <marocchino@users.noreply.github.com>
This commit is contained in:
Gunar Gessner 2021-07-27 12:09:26 +01:00 committed by GitHub
parent 4a39893edd
commit 7a381217a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -107,6 +107,7 @@ with:
```yaml
uses: marocchino/sticky-pull-request-comment@v2
with:
header: <same-header-as-the-step-that-added-the-comment>
delete: true
```
@ -131,7 +132,7 @@ is explicitly passed, this problem can be solved by just removing it.
### `delete`
**Optional** Delete the previously created comment. Only `true` is allowed. Just skip this option when you don't need it.
**Optional** Delete a previously created comment. Use `header` to point to which comment you want to delete. Only `true` is allowed (i.e. delete this option if you don't need it).
### `message`