-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: manage delete modes in a better way + consistent input naming #391
Conversation
BREAKING CHANGE: delete now deletes a comment immediately. To delete the comment at the end of the job, use `delete-on-completion` Co-authored-by: mlahargou <[email protected]>
Current branch is |
Comment Pull Request - GitHub ActionsWhat is it ?A GitHub action that comments with a given message the pull request linked to the pushed branch. UsageClassic usageon: pull_request
jobs:
example_comment_pr:
runs-on: ubuntu-latest
name: An example job to comment a PR
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Comment PR
uses: thollander/actions-comment-pull-request@v3
with:
message: |
Hello world ! :wave: Comment a file contentThanks to the - name: PR comment with file
uses: thollander/actions-comment-pull-request@v3
with:
filePath: /path/to/file.txt Setting reactionsYou can also set some reactions on your comments through the - name: PR comment with reactions
uses: thollander/actions-comment-pull-request@v3
with:
message: |
Hello world ! :wave:
reactions: eyes, rocket Specifying which pull request to comment onYou can explicitly input which pull request should be commented on by passing the ...
- name: Comment PR
uses: thollander/actions-comment-pull-request@v3
with:
message: |
Hello world ! :wave:
pr_number: 123 # This will comment on pull request #123 Update a commentEditing an existing comment is also possible thanks to the Thanks to this parameter, it will be possible to identify your comment and then to upsert on it. That is particularly interesting while committing multiple times in a PR and that you just want to have the last execution report printed. It avoids flooding the PR. ...
- name: Comment PR with execution number
uses: thollander/actions-comment-pull-request@v3
with:
message: |
_(execution **${{ github.run_id }}** / attempt **${{ github.run_attempt }}**)_
comment_tag: execution Note: the input Delete a commentDeleting a comment with a specific ...
- name: Delete a comment
uses: thollander/actions-comment-pull-request@v3
with:
comment_tag: to_delete
mode: delete Delete a comment on job completionDeleting an existing comment on job completion is also possible thanks to the This will delete the comment at the end of the job. ...
- name: Write a comment that will be deleted at the end of the job
uses: thollander/actions-comment-pull-request@v3
with:
message: |
The PR is being built...
comment_tag: to_delete_on_completion
mode: delete-on-completion InputsAction inputs
OutputsAction outputsYou can get some outputs from this actions :
Example output- name: Comment PR
uses: thollander/actions-comment-pull-request@v3
id: hello
with:
message: |
Hello world ! :wave:
- name: Check outputs
run: |
echo "id : ${{ steps.hello.outputs.id }}"
echo "body : ${{ steps.hello.outputs.body }}"
echo "html-url : ${{ steps.hello.outputs.html-url }}" PermissionsDepending on the permissions granted to your token, you may lack some rights. permissions:
pull-requests: write Add this in case you get
ContributingBuildThe build steps transpiles the $ npm run build |
Content of file referenced with absolute path |
BREAKING CHANGE: delete now deletes a comment immediately. To delete the comment at the end of the job, use
delete-on-completion
Credits to @mlahargou (#371)
Closes #386
Closes #361