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

Reword readme (#296)

Browse source 
With some guidance from https://app.grammarly.com/
This commit is contained in:
Josh Soref 2021-05-05 21:42:59 -04:00 committed by GitHub
parent 9d26ef6408
commit e757c06970
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,6 +1,6 @@
# Sticky Pull Request Comment # Sticky Pull Request Comment
Create comment on pull request, if exists update that comment. Create a comment on a pull request, if it exists update that comment.
This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading [this page](https://docs.github.com/en/actions) first. This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading [this page](https://docs.github.com/en/actions) first.
## Usage ## Usage
@ -80,8 +80,8 @@ If for some reason, triggering on pr is not possible, you can use push.
with: with:
number: ${{ steps.finder.outputs.pr }} number: ${{ steps.finder.outputs.pr }}
message: | message: |
Test ${{ github.sha }} is successfully ended. Test ${{ github.sha }} ended successfully.
This is message from push. This message is from a push.
``` ```
### Read comment from a file ### Read comment from a file
@ -92,7 +92,7 @@ with:
path: path-to-comment-contents.txt path: path-to-comment-contents.txt
``` ```
### Delete previous commit and add comment at bottom ### Delete the previous comment and add a comment at the end
```yaml ```yaml
uses: marocchino/sticky-pull-request-comment@v2 uses: marocchino/sticky-pull-request-comment@v2
@ -112,42 +112,42 @@ with:
### Error: Resource not accessible by integration ### Error: Resource not accessible by integration
That message means requester has not enough permission. If `secrets.GITHUB_TOKEN` This message means the requester does not have enough permission. If `secrets.GITHUB_TOKEN`
is explicitly passed, this problem can be solved by just deleting that part. is explicitly passed, this problem can be solved by just removing it.
## Inputs ## Inputs
### `header` ### `header`
**Optional** Header to determine if the comment is to be updated, not shown on screen. It can be used when you want to add multiple comments independently at the same time. **Optional** Header to determine if the comment should be updated (it is not shown to users). It can be used when you want to add multiple comments independently to a given object.
### `append` ### `append`
**Optional** Indicate if new comment messages should be appended to previous comment message. Only `true` is allowed. Just skip this item when you don't need it. **Optional** Indicate if new comment messages should be appended to previous comment message. Only `true` is allowed. Just skip this option when you don't need it.
### `recreate` ### `recreate`
**Optional** Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this item when you don't need it. **Optional** Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this option when you don't need it.
### `delete` ### `delete`
**Optional** delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it. **Optional** Delete the previously created comment. Only `true` is allowed. Just skip this option when you don't need it.
### `message` ### `message`
**Optional** comment message **Optional** Comment message
### `path` ### `path`
**Optional** path to file containing comment message **Optional** Path to file containing comment message
### `number` ### `number`
**Optional** pull request number for push event. Note that this is **lower priority** than number from pull request event. **Optional** Pull request number for push event. Note that this has a **lower priority** than the number of a pull_request event.
### `repo` ### `repo`
**Optional** other repo name limited use on github enterprise. If not set, the current repo is used by default. Note that When you trying changing a repo, be aware that GITHUB_TOKEN should also use that repo's. **Optional** Another repository name. Of limited use on GitHub enterprise. If not set, the current repository is used by default. Note that when you trying changing a repo, be aware that `GITHUB_TOKEN` should also have permission for that repository.
### `GITHUB_TOKEN` ### `GITHUB_TOKEN`
@ -155,7 +155,7 @@ is explicitly passed, this problem can be solved by just deleting that part.
## Outputs ## Outputs
no outputs None
## Any problem? ## Any problem?