You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Maintain One Comment
v3.0.0
Maintain just one comment in Issue and PR.
- This Action is only applicable to triggers related to issue and pull_request
- When the filtered comments do not exist, will add a comment
- When the filtered comments is only one, this comment will be updated
- When the number of filtered comments exceeds 1, no operation will be performed
name: Maintain One Comment
on:
issues:
types: [opened, edited]
issue_comment:
types: [created, edited]
pull_request:
types: [assigned, opened, synchronize, edited]
jobs:
comment:
runs-on: ubuntu-latest
steps:
- name: maintain-comment
uses: actions-cool/maintain-one-comment@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
body: |
Hi π
emojis: '+1, laugh'
body-include: '<!-- Created by actions-cool/maintain-one-comment -->'
Name | Desc | Type | Required |
---|---|---|---|
token | GitHub token | string | β |
number | Manually control the issue or PR number | string | β |
body | Create comment body | string | β |
emojis | Add emoji | string | β |
update-mode | Comment update mode. Options: replace append . Default: replace |
string | β |
comment-auth | Filter comment auth | string | β |
body-include | Filter comment body | string | β |
delete | Will delete all filter comments. Default false |
boolean | β |
number
: When no input, it will be the issue or PR number that triggered. When input, it is the highest prioritybody
: When has 1 comment, and no body input will delete this filter comment
comment-id
: Return the ID of create or updated comment.- About
comment-id
use, can refer: https://github.com/actions-cool/issues-helper
- About
- When PR come from fork, it requires
pull_request_target
to comment (Reasons for github built-in permissions). When usepull_request_target
, must read
input | emoji |
---|---|
+1 |
π |
-1 |
π |
laugh |
π |
confused |
π |
heart |
β€οΈ |
hooray |
π |
rocket |
π |
eyes |
π |