mirror of
https://github.com/mshick/add-pr-comment.git
synced 2025-12-31 14:20:32 +11:00
655ef16eab
* docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
200 lines
No EOL
9.7 KiB
Markdown
200 lines
No EOL
9.7 KiB
Markdown
# add-pr-comment
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
[](#contributors-)
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
|
|
A GitHub Action which adds a comment to a pull request's issue.
|
|
|
|
This actions also works on [issue](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues),
|
|
[issue_comment](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue_comment),
|
|
[deployment_status](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment_status),
|
|
[push](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push)
|
|
and any other event where an issue can be found directly on the payload or via a commit sha.
|
|
|
|
## Features
|
|
|
|
- Modify issues for PRs merged to main.
|
|
- By default will post "sticky" comments. If on a subsequent run the message text changes the original comment will be updated.
|
|
- Multiple sticky comments allowed by setting unique `message-id`s.
|
|
- Optional message overrides based on job status.
|
|
- Multiple posts to the same conversation optionally allowable.
|
|
- Supports a proxy for fork-based PRs. [See below](#proxy-for-fork-based-prs).
|
|
- Supports creating a message from a file path.
|
|
|
|
## Usage
|
|
|
|
Note that write access needs to be granted for the pull-requests scope.
|
|
|
|
```yaml
|
|
on:
|
|
pull_request:
|
|
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
steps:
|
|
- uses: mshick/add-pr-comment@v2
|
|
with:
|
|
message: |
|
|
**Hello**
|
|
🌏
|
|
!
|
|
```
|
|
|
|
You can even use it on PR Issues that are related to PRs that were merged into main, for example:
|
|
|
|
```yaml
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
steps:
|
|
- uses: mshick/add-pr-comment@v2
|
|
with:
|
|
message: |
|
|
**Hello MAIN**
|
|
```
|
|
|
|
## Configuration options
|
|
|
|
| Input | Location | Description | Required | Default |
|
|
|--------------------------|----------|------------------------------------------------------------------------------------------------------|----------|------------------------------------|
|
|
| message | with | The message you'd like displayed, supports Markdown and all valid Unicode characters. | maybe | |
|
|
| message-path | with | Path to a message you'd like displayed. Will be read and displayed just like a normal message. | maybe | |
|
|
| message-success | with | A message override, printed in case of success. | no | |
|
|
| message-failure | with | A message override, printed in case of failure. | no | |
|
|
| message-cancelled | with | A message override, printed in case of cancelled. | no | |
|
|
| message-skipped | with | A message override, printed in case of skipped. | no | |
|
|
| status | with | Required if you want to use message status overrides. | no | {{ job.status }} |
|
|
| repo-owner | with | Owner of the repo. | no | {{ github.repository_owner }} |
|
|
| repo-name | with | Name of the repo. | no | {{ github.event.repository.name }} |
|
|
| repo-token | with | Valid GitHub token, either the temporary token GitHub provides or a personal access token. | no | {{ github.token }} |
|
|
| message-id | with | Message id to use when searching existing comments. If found, updates the existing (sticky comment). | no | |
|
|
| refresh-message-position | with | Should the sticky message be the last one in the PR's feed. | no | false |
|
|
| allow-repeats | with | Boolean flag to allow identical messages to be posted each time this action is run. | no | false |
|
|
| proxy-url | with | String for your proxy service URL if you'd like this to work with fork-based PRs. | no | |
|
|
| issue | with | Optional issue number override. | no | |
|
|
| GITHUB_TOKEN | env | Valid GitHub token, can alternatively be defined in the env. | no | |
|
|
|
|
## Advanced Uses
|
|
|
|
### Proxy for Fork-based PRs
|
|
|
|
GitHub limits `GITHUB_TOKEN` and other API access token permissions when creating a PR from a fork. This precludes adding comments when your PRs are coming from forks, which is the norm for open source projects. To work around this situation I've created a simple companion app you can deploy to Cloud Run or another host to proxy the create comment requests with a personal access token you provide.
|
|
|
|
See this issue: https://github.community/t/github-actions-are-severely-limited-on-prs/18179/4 for more details.
|
|
|
|
Check out the proxy service here: https://github.com/mshick/add-pr-comment-proxy
|
|
|
|
**Example**
|
|
|
|
```yaml
|
|
on:
|
|
pull_request:
|
|
|
|
jobs:
|
|
pr:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
steps:
|
|
- uses: mshick/add-pr-comment@v2
|
|
with:
|
|
message: |
|
|
**Howdie!**
|
|
proxy-url: https://add-pr-comment-proxy-94idvmwyie-uc.a.run.app
|
|
```
|
|
|
|
### Status Message Overrides
|
|
|
|
You can override your messages based on your job status. This can be helpful
|
|
if you don't anticipate having the data required to create a helpful message in
|
|
case of failure, but you still want a message to be sent to the PR comment.
|
|
|
|
**Example**
|
|
|
|
```yaml
|
|
on:
|
|
pull_request:
|
|
|
|
jobs:
|
|
pr:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
steps:
|
|
- uses: mshick/add-pr-comment@v2
|
|
if: always()
|
|
with:
|
|
message: |
|
|
**Howdie!**
|
|
message-failure: |
|
|
Uh oh!
|
|
```
|
|
|
|
### Bring your own issues
|
|
|
|
You can set an issue id explicitly. Helpful for cases where you want to post
|
|
to an issue but for some reason the event would not allow the id to be determined.
|
|
|
|
**Example**
|
|
|
|
> In this case `add-pr-comment` should have no problem finding the issue number
|
|
> on its own, but for demonstration purposes.
|
|
|
|
```yaml
|
|
on:
|
|
deployment_status:
|
|
|
|
jobs:
|
|
pr:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
steps:
|
|
- id: pr
|
|
run: |
|
|
issue=$(gh pr list --search "${{ github.sha }}" --state open --json number --jq ".[0].number")
|
|
echo "issue=$issue" >>$GITHUB_OUTPUT
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- uses: mshick/add-pr-comment@v2
|
|
with:
|
|
issue: ${{ steps.pr.outputs.issue }}
|
|
message: |
|
|
**Howdie!**
|
|
```
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://app.lizardbyte.dev"><img src="https://avatars.githubusercontent.com/u/42013603?v=4?s=100" width="100px;" alt="ReenigneArcher"/><br /><sub><b>ReenigneArcher</b></sub></a><br /><a href="https://github.com/mshick/add-pr-comment/commits?author=ReenigneArcher" title="Code">💻</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aryella-lacerda"><img src="https://avatars.githubusercontent.com/u/28730324?v=4?s=100" width="100px;" alt="Aryella Lacerda"/><br /><sub><b>Aryella Lacerda</b></sub></a><br /><a href="https://github.com/mshick/add-pr-comment/commits?author=aryella-lacerda" title="Code">💻</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/vincent-joignie-dd"><img src="https://avatars.githubusercontent.com/u/103102299?v=4?s=100" width="100px;" alt="vincent-joignie-dd"/><br /><sub><b>vincent-joignie-dd</b></sub></a><br /><a href="https://github.com/mshick/add-pr-comment/commits?author=vincent-joignie-dd" title="Code">💻</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://ahanoff.dev"><img src="https://avatars.githubusercontent.com/u/2371703?v=4?s=100" width="100px;" alt="Akhan Zhakiyanov"/><br /><sub><b>Akhan Zhakiyanov</b></sub></a><br /><a href="https://github.com/mshick/add-pr-comment/commits?author=ahanoff" title="Code">💻</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |