mirror of
https://github.com/marocchino/sticky-pull-request-comment.git
synced 2025-12-15 04:46:22 +00:00
162 lines
4.2 KiB
Markdown
162 lines
4.2 KiB
Markdown
# Sticky Pull Request Comment
|
||
|
||
Create comment on pull request, if 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.
|
||
|
||
## Usage
|
||
|
||
### Basic
|
||
|
||
```yaml
|
||
uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
message: |
|
||
Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
|
||
```
|
||
|
||
### Keep more than one comment
|
||
|
||
In some cases, different actions may require different comments. The header allows you to maintain comments independently.
|
||
|
||
```yaml
|
||
release:
|
||
...
|
||
- uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
header: release
|
||
message: |
|
||
Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
|
||
|
||
test:
|
||
...
|
||
- name: Run Test
|
||
id: test
|
||
run: |
|
||
OUTPUT=$(rake test)
|
||
OUTPUT="${OUTPUT//'%'/'%25'}【7,6 m】"
|
||
OUTPUT="${OUTPUT//$'\n'/'%0A'}"
|
||
OUTPUT="${OUTPUT//$'\r'/'%0D'}"
|
||
echo "::set-output name=result::$OUTPUT"
|
||
- uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
header: test
|
||
message: |
|
||
```
|
||
${{ steps.test.outputs.result }}
|
||
```
|
||
```
|
||
|
||
### Append after comment every time it runs
|
||
|
||
```yaml
|
||
test:
|
||
...
|
||
- name: Run Test
|
||
id: test
|
||
run: |
|
||
OUTPUT=$(rake test)
|
||
OUTPUT="${OUTPUT//'%'/'%25'}【7,6 m】"
|
||
OUTPUT="${OUTPUT//$'\n'/'%0A'}"
|
||
OUTPUT="${OUTPUT//$'\r'/'%0D'}"
|
||
echo "::set-output name=result::$OUTPUT"
|
||
- uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
append: true
|
||
message: |
|
||
Test with ${{ github.sha }}.
|
||
```
|
||
${{ steps.test.outputs.result }}
|
||
```
|
||
```
|
||
|
||
### Comment from push
|
||
|
||
If for some reason, triggering on pr is not possible, you can use push.
|
||
|
||
```yaml
|
||
- uses: jwalton/gh-find-current-pr@v1
|
||
id: finder
|
||
- uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
number: ${{ steps.finder.outputs.pr }}
|
||
message: |
|
||
Test ${{ github.sha }} is successfully ended.
|
||
This is message from push.
|
||
```
|
||
|
||
### Read comment from a file
|
||
|
||
```yaml
|
||
uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
path: path-to-comment-contents.txt
|
||
```
|
||
|
||
### Delete previous commit and add comment at bottom
|
||
|
||
```yaml
|
||
uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
recreate: true
|
||
message: |
|
||
Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
|
||
```
|
||
|
||
### Delete previous comment
|
||
|
||
```yaml
|
||
uses: marocchino/sticky-pull-request-comment@v2
|
||
with:
|
||
delete: true
|
||
```
|
||
|
||
### Error: Resource not accessible by integration
|
||
|
||
That message means requester has not enough permission. If `secrets.GITHUB_TOKEN`
|
||
is explicitly passed, this problem can be solved by just deleting that part.
|
||
|
||
## Inputs
|
||
|
||
### `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.
|
||
|
||
### `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.
|
||
|
||
### `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.
|
||
|
||
### `delete`
|
||
|
||
**Optional** delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it.
|
||
|
||
### `message`
|
||
|
||
**Optional** comment message
|
||
|
||
### `path`
|
||
|
||
**Optional** path to file containing comment message
|
||
|
||
### `number`
|
||
|
||
**Optional** pull request number for push event. Note that this is **lower priority** than number from pull request event.
|
||
|
||
### `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.
|
||
|
||
### `GITHUB_TOKEN`
|
||
|
||
**Optional**, You can set [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) here. If not set, this will use `${{ github.token }}`.
|
||
|
||
## Outputs
|
||
|
||
no outputs
|
||
|
||
## Any problem?
|
||
|
||
Feel free to report issues. 😃
|