maintain-one-comment
maintain-one-comment copied to clipboard
📌 Maintain just one comment in Issue and PR by GitHub Action.
📌 Maintain One Comment
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
Preview
- Issue: https://github.com/actions-cool/maintain-one-comment/issues/1
- PR: https://github.com/actions-cool/maintain-one-comment/pull/2
How to use?
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 -->'
Inputs
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 priority -
body
: When has 1 comment, and no body input will delete this filter comment
Outputs
-
comment-id
: Return the ID of create or updated comment.- About
comment-id
use, can refer: https://github.com/actions-cool/issues-helper
- About
Note
- When PR come from fork, it requires
pull_request_target
to comment (Reasons for github built-in permissions). When usepull_request_target
, must read
Emoji List
input | emoji |
---|---|
+1 |
👍 |
-1 |
👎 |
laugh |
😄 |
confused |
😕 |
heart |
❤️ |
hooray |
🎉 |
rocket |
🚀 |
eyes |
👀 |
Changelog
CHANGELOG
LICENSE
MIT