GitHub Action
Simple comment PR
Simple action that allows you to add comments to the PR in your workflow.
You can do multiple comments during the workflow execution via different identifiers. See example bellow.
| Name | Description | Required | Default |
|---|---|---|---|
| message | Message that you want in the comment (markdown supported) | message or file | |
| file | File name of the message (file needs to be placed in .github/workflows/) |
message or file | |
| single_comment | Would you like to update existing comment (if exists) instead of creating new one every time? | no | true |
| identifier | Identifier that we put as comment in the comment, so that we can identify them | no | GITHUB_ACTION_COMMENT_PR |
| github_token | Github token that we use to create/update commit | yes |
It's required to provide message or file input. If both are provided message input will be used.
| Name | Description | Return |
|---|---|---|
| commented | Reports status on comment creation | 'true' / 'false' |
uses: NejcZdovc/comment-pr@v1
with:
message: "Hello world"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}uses: NejcZdovc/comment-pr@v1
with:
file: "comment.md"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}File should be placed in .github/workflows and it should be .md.
uses: NejcZdovc/comment-pr@v1
with:
file: "comment.md"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
DATA: 'year 2020'When you need to pass data from workflow info file you just define new env variable. That will be automatically replaced in the template.
Example of comment.md that uses DATA env variable.
It's almost end of {DATA}!With specifying different identifier per step we will now track two different comments, and they will be updated accordingly.
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Comment Checkout
uses: NejcZdovc/comment-pr@v1
with:
message: "Checkout completed!"
identifier: "GITHUB_COMMENT_CHECKOUT"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Get time
uses: actions/github-script@v3
id: get-time
with:
script: return new Date().toString()
result-encoding: string
- name: Comment time
uses: NejcZdovc/comment-pr@v1
with:
message: "Execution time: `${{steps.get-time.outputs.result}}`"
identifier: "GITHUB_COMMENT_SCRIPT"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}You can pass github token two ways:
uses: NejcZdovc/comment-pr@v1
with:
message: "Hello world"
github_token: ${{secrets.GITHUB_TOKEN}}uses: NejcZdovc/comment-pr@v1
with:
message: "Hello world"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}Please file an issue for bugs, missing documentation, or unexpected behavior.