A GitHub Action which adds a comment to a pull request's issue.
This actions also works on issue, issue_comment, deployment_status, push and any other event where an issue can be found directly on the payload or via a commit sha.
- 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.
- Supports creating a message from a file path.
Note that write access needs to be granted for the pull-requests scope.
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:
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**
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 | |
status | with | Required if you want to use message status overrides. | no | {{ job.status }} |
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 |
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
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
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
on:
pull_request:
jobs:
pr:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: mshick/add-pr-comment@v2
if: always()
with:
status: ${{ job.status }}
message: |
**Howdie!**
message-failure: |
Uh oh!
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.
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!**