Repository files navigation

English |简体中文

• Online documentation
• Online v2 documentation
• Changelog

1. Complete free
2. Fully automatic
3. Hosted on the GitHub server, as long as GitHub is not down, it is not affected

Private projects have a limit of 2000 times per month.Specific view. Public are unlimited.

Please leave a message athere.

ant-design	ant-design-blazor	ant-design-mobile	ant-design-vue
bootstrap	dumi	electron	element-plus
formily	jsx-next	material-ui	nutui
prettier	react-component	react-music-player	S2
swiper	umi	vite	vitest
vue-request	vuepress-next	zoo

If you thinkactions-cool can help you, please copy it to the README to support promotion and bring convenience to more repositories:.More color see.

[![actions-cool](https://img.shields.io/badge/using-actions--cool-blue?style=flat-square)](https://github.com/actions-cool)

You are very welcome to try it out and put forward your comments. You can use the following methods:

• Report bugs or consult withIssue
• Discuss viaDiscussions
• SubmitPull Request to improve the code ofissues-helper

When the following list does not have the features you want, you can submit it inissues.

• ⭐ Base
  • add-assignees
  • add-labels
  • close-issue
  • create-comment
  • create-issue
  • create-label
  • delete-comment
  • get-issue
  • lock-issue
  • open-issue
  • remove-assignees
  • remove-labels
  • set-labels
  • unlock-issue
  • update-comment
  • update-issue
• 🌟 Advanced
  • check-inactive
  • check-issue
  • close-issues
  • find-comments
  • find-issues
  • lock-issues
  • mark-assignees
  • mark-duplicate
  • toggle-labels
  • welcome

In order to better display the function, the following is an example of the actual scene, please refer to it flexibly.

When an issue is added or modified, assign this issue to one or more people.

name:Add Assignesson:issues:types:[opened, edited]jobs:add-assigness:runs-on:ubuntu-lateststeps:      -name:Add assignessuses:actions-cool/issues-helper@v3with:actions:'add-assignees'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}assignees:'xxx'or 'xx1,xx2'random-to:1

• actions support multiple and separated by comma. Like:add-assignees,add-labels
• Thename can be modified according to the actual situation
• Reference to on
• ${{ github.event.issue.number }} is the current issue.More references
• assignees support multiple and separated by comma
• You can assign up to 10 people to each issue

⏫ Back to list

When the content of a new issue does not contain the specified format, add labels for the issue.

name:Add Labelson:issues:types:[opened]jobs:add-labels:runs-on:ubuntu-latestif:contains(github.event.issue.body, 'xxx') == falsesteps:      -name:Add labelsuses:actions-cool/issues-helper@v3with:actions:'add-labels'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}labels:'bug'or 'xx1,xx2'

• labels support multiple and separated by comma

⏫ Back to list

Close the specified issue.

-name:Close issueuses:actions-cool/issues-helper@v3with:actions:'close-issue'token:${{ secrets.GITHUB_TOKEN }}issue-number:xxx

⏫ Back to list

When a designated label is added, comment on the issue.

name:Create Commenton:issues:types:[labeled]jobs:create-comment:runs-on:ubuntu-latestif:github.event.label.name == 'xxx'steps:      -name:Create commentuses:actions-cool/issues-helper@v3with:actions:'create-comment'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}body:|            Hello @${{ github.event.issue.user.login }}. Add some comments.            你好 @${{ github.event.issue.user.login }}。巴拉巴拉。emoji:'+1'or '+1,heart'

• No action whenbody is empty
• Returncomment-id, which can be used for subsequent operations.Usage reference
• ${{ github.event.issue.user.login }} indicates the creator of the issue
• emoji support multiple and separated by comma

⏫ Back to list

Here is an example, add an issue at UTC 00:00 on the 1st of every month.

name:Create Issueon:schedule:    -cron:"0 0 1 * *"jobs:create-issue:runs-on:ubuntu-lateststeps:      -name:Create issueuses:actions-cool/issues-helper@v3with:actions:'create-issue'token:${{ secrets.GITHUB_TOKEN }}title:'xxxx'body:'xxxx'labels:'xx'assignees:'xxx'emoji:'+1'

• No action whentitle is empty
• Returnissue-number.Usage reference

⏫ Back to list

Create label. If you want to maintain labels in batches,see.

-name:Create labeluses:actions-cool/issues-helper@v3with:actions:'create-label'token:${{ secrets.GITHUB_TOKEN }}label-name:'xx'label-color:'0095b3'label-desc:'xx'

• label-name: If it already exists, no operation
• label-color: Default isededed

⏫ Back to list

According tocomment-id delete the specified comment.

-name:Delete commentuses:actions-cool/issues-helper@v3with:actions:'delete-comment'token:${{ secrets.GITHUB_TOKEN }}comment-id:xxx

⏫ Back to list

Query issue information.

-name:Get Issueuses:actions-cool/issues-helper@v3with:actions:'get-issue'token:${{ secrets.GITHUB_TOKEN }}

• Returnissue-numberissue-titleissue-bodyissue-labelsissue-assigneesissue-state.Usage reference

⏫ Back to list

When theinvalid label is added, the issue is locked.

name:Lock Issueon:issues:types:[labeled]jobs:lock-issue:runs-on:ubuntu-latestif:github.event.label.name == 'invalid'steps:      -name:Lock issueuses:actions-cool/issues-helper@v3with:actions:'lock-issue'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}

• lock-reason: Optional values areoff-topictoo heatedresolvedspam

⏫ Back to list

Open the specified issue.

-name:Open issueuses:actions-cool/issues-helper@v3with:actions:'open-issue'token:${{ secrets.GITHUB_TOKEN }}issue-number:xxx

⏫ Back to list

Remove the person designated by issue.

-name:Remove assigneesuses:actions-cool/issues-helper@v3with:actions:'remove-assignees'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}assignees:'xx'

⏫ Back to list

Remove the specified labels.

-name:Remove labelsuses:actions-cool/issues-helper@v3with:actions:'remove-labels'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}labels:'xx'

• labels supports multiple, such asx1,x2,x3, only the labels added by the issue will be removed

⏫ Back to list

Replace the labels of issue.

-name:Set labelsuses:actions-cool/issues-helper@v3with:actions:'set-labels'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}labels:'xx'

⏫ Back to list

Unlock the specified issue.

-name:Unlock issueuses:actions-cool/issues-helper@v3with:actions:'unlock-issue'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}

⏫ Back to list

Update the specified comment according tocomment-id.

The following example shows that 👀 is added for each new comment.

name:Add eyes to each commenton:issue_comment:types:[created]jobs:update-comment:runs-on:ubuntu-lateststeps:      -name:Update commentuses:actions-cool/issues-helper@v3with:actions:'update-comment'token:${{ secrets.GITHUB_TOKEN }}comment-id:${{ github.event.comment.id }}emoji:'eyes'

• Whenbody is not entered, it will remain as it is
• Whenupdate-mode isappend, additional operations will be performed. Anything other thanappend will be replaced. Only effective forbody

⏫ Back to list

Update the specified issue according to theissue-number.

-name:Update issueuses:actions-cool/issues-helper@v3with:actions:'update-issue'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}state:'open'title:'xxx'body:'xxxx'update-mode:'replace'labels:'xx'assignees:'xxx'emoji:'+1'

• state defaults toopen
• When the option is not filled, it will keep the original

⏫ Back to list

Advanced usage is not recommended to use multiple actions at the same time.

At UTC 0 on the 1st of each month, add theinactive tag to all issues that have not been active for more than 30 days.

name:Check inactiveon:schedule:    -cron:"0 0 1 * *"jobs:check-inactive:runs-on:ubuntu-lateststeps:      -name:check-inactiveuses:actions-cool/issues-helper@v3with:actions:'check-inactive'token:${{ secrets.GITHUB_TOKEN }}inactive-day:30

• labels: When there are multiple, the query will have multiple at the same time. If not entered, all
• issue-state: The default isall. Optional valueopenclosed, when these 2 items are not, both areall
• issue-assignee: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Enteringnone will query issues for which the specified person is not added
• inactive-day: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
• inactive-label: The default isinactive, others can be customized. When the project does not contain the label, it will be created automatically
• exclude-labels: When set to include$exclude-empty, no label issue can be excluded
• inactive-mode:
  • Defaultissue: the issue updated time
  • Optionalcomment: the last comment update time
  • Optionalissue-created: the issue created time
  • Optionalcomment-created: the comment creation time
  • You can also set multiple such as:comment, issue-created
    • It will be detected with priority, the update time of the last comment will be detected first, if there is no comment, the creation time of the issue will be used

⏫ Back to list

Check whether the issue meets the conditions according to the passed parameters andissue-number, and return a boolean value.

The effect of the following example is: when an issue is newly opened, verify whether the current issue designator containsx1 orx2.

If one designated person is satisfied, the verification will pass, and at the same time, verify whether the title meets the conditions.Check rules

name:Check Issueon:issues:types:[edited]jobs:check-issue:runs-on:ubuntu-lateststeps:      -name:check-issueuses:actions-cool/issues-helper@v3with:actions:'check-issue'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}assignee-includes:'x1,x2'title-includes:'x1,x2/y1,y2'

• title-includesbody-includes supports the formatx1,x2 orx1,x2/y1,y2. Only supports two levels
• Returncheck-result, due to yml reasons, the judgment condition isif: steps.xxid.outputs.check-result =='true'

⏫ Back to list

Every 7 days at UTC 0, close the issues that have been filled with theneed info label and have not been active for more than 7 days.

name:Check need infoon:schedule:    -cron:"0 0 */7 * *"jobs:check-need-info:runs-on:ubuntu-lateststeps:      -name:close-issuesuses:actions-cool/issues-helper@v3with:actions:'close-issues'token:${{ secrets.GITHUB_TOKEN }}labels:'need info'inactive-day:7

• labels: When there are multiple, the query will have multiple at the same time. If not entered, all
• issue-assignee: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Enteringnone will query issues for which the specified person is not added
• inactive-day: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
• exclude-labels: When set to include$exclude-empty, no label issue can be excluded

⏫ Back to list

Find the current warehouse issue No. 1, the creator is k and the content contains the comment list ofthis.

-name:Find commentsuses:actions-cool/issues-helper@v3with:actions:'find-comments'token:${{ secrets.GITHUB_TOKEN }}issue-number:1comment-auth:'k'body-includes:'this,that'

• Returncomments in the following format:

[{id:1,auth:'x',body:'xxx',created:'',updated:''},{id:2,auth:'x',body:'xxx',created:'',updated:''},]

• direction defaults to ascending order, only whendesc is set, descending order will be returned
• Thecreatedupdated in the returned array, determined by the environment, will be UTC +0

⏫ Back to list

Find the current repository, the creator is k , the title containsthis , the body containsthat, and the list of issues in the open state.

-name:Find issuesuses:actions-cool/issues-helper@v3with:actions:'find-issues'token:${{ secrets.GITHUB_TOKEN }}issue-creator:'k'issue-state:'open'title-includes:'this'body-includes:'that'labels:'documentation'

• Returnsissues in the following format:

[{number:1,auth:'x',body:'xxx',body:'xxx',state:'open',assignees:['x1','x2'],created:'',updated:''},{number:2,auth:'x',body:'xxx',body:'xxx',state:'closed',assignees:['x1','x2'],created:'',updated:''},]

• issue-state: The default isopen. Other values are:closed,all
• direction defaults to ascending order, only whendesc is set, descending order will be returned
• Thecreatedupdated in the returned array, determined by the environment, will be UTC +0
• exclude-labels: When set to include$exclude-empty, no label issue can be excluded

⏫ Back to list

Every 3 months at UTC 0 on the 1st, lock all issues that have been filled with theinactive label and have not been active for more than 128 days.

name:Lock inactive issueson:schedule:    -cron:"0 0 1 */3 *"jobs:lock-issues:runs-on:ubuntu-lateststeps:      -name:lock-issuesuses:actions-cool/issues-helper@v3with:actions:'lock-issues'token:${{ secrets.GITHUB_TOKEN }}labels:'inactive'inactive-day:128

• labels: When there are multiple, the query will have multiple at the same time. If not entered, all
• issue-state: The default isall. Optional valueopenclosed, when these 2 items are not, both areall
• issue-assignee: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Enteringnone will query issues for which the specified person is not added
• inactive-day: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
• exclude-labels: When set to include$exclude-empty, no label issue can be excluded

⏫ Back to list

Quickly assign person, only for the issue to add editor comments.

name:Issue Mark Assigneeson:issue_comment:types:[created, edited]jobs:mark-assignees:runs-on:ubuntu-lateststeps:      -name:mark-assigneesuses:actions-cool/issues-helper@v3with:actions:'mark-assignees'token:${{ secrets.GITHUB_TOKEN }}

• assign-command: default/assign
• require-permission: Optional values areadmin,write,read,none
  • If the team member sets theread permission, it isread
  • If the external Collaborator is set toread permission, it isread
  • Ordinary users haveread permission
  • When setwrite,admin andwrite meet the conditions

⏫ Back to list

Quickly mark duplicate questions, only for issue new comments or edit comments.

name:Issue Mark Duplicateon:issue_comment:types:[created, edited]jobs:mark-duplicate:runs-on:ubuntu-lateststeps:      -name:mark-duplicateuses:actions-cool/issues-helper@v3with:actions:'mark-duplicate'token:${{ secrets.GITHUB_TOKEN }}

• duplicate-command: When setting concise commands, while still supporting the originalDuplicate of. Block content contains?
• labels: Highest priority
• close-issue: Bothtrue or'true' can take effect
• require-permission: Optional values areadmin,write,read,none
  • If the team member sets theread permission, it isread
  • If the external Collaborator is set toread permission, it isread
  • Ordinary users haveread permission
  • When setwrite,admin andwrite meet the conditions

⏫ Back to list

When an issue is reopened, the set labels are removed if they already exist, otherwise they are added.

name:Toggle Labelson:issues:types:[reopened]jobs:toggle-labels:runs-on:ubuntu-lateststeps:      -name:Toggle labelsuses:actions-cool/issues-helper@v3with:actions:'toggle-labels'token:${{ secrets.GITHUB_TOKEN }}issue-number:${{ github.event.issue.number }}labels:'unread,outdated'

⏫ Back to list

When an issue is created, the user who created the issue for the first time is welcome.

If the user is not creating for the first time, there is no operation.

name:Issue Welcomeon:issues:types:[opened]jobs:issue-welcome:runs-on:ubuntu-lateststeps:      -name:welcomeuses:actions-cool/issues-helper@v3with:actions:'welcome'token:${{ secrets.GITHUB_TOKEN }}body:hi @${{ github.event.issue.user.login }}, welcome!labels:'welcome1, welcome2'assignees:'xx1'issue-emoji:'+1, -1, eyes'

• If these 4 options are not filled, no operation

⏫ Back to list

Need to have the person token with push permission.

• Personal token application
  • Need to checkFull control of private repositories
• Project add secrets
  • Select settings, select secrets, selectNew repository secret
  • Name is the same as in actions
  • Value fill in the token just applied by the individual

When the token is not filled in actions or input${{ secrets.GITHUB_TOKEN }}, it will default togithub-actions-bot.More.

⏫ Back to list

• Workflow syntax for GitHub Actions
• Events that trigger workflows

⏫ Back to list

-name:Create issueuses:actions-cool/issues-helper@v3id:createissuewith:actions:'create-issue'token:${{ secrets.GITHUB_TOKEN }}-name:Check outputsrun:echo "Outputs issue_number is ${{ steps.createissue.outputs.issue-number }}"

More:

1. https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/metadata-syntax-for-github-actions#outputs
2. https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idoutputs

⏫ Back to list

"title-includes":'x1,x2'x1x2"x1y3y2"true"y2 x1"true"x2"true"x3"false

"title-includes":'x1,x2/y1,y2'x1+y1x2+y1x1+y2x2+y2"x1y3y2"true"y2 x1"true"1x2y"false"x1"false

⏫ Back to list

⏫ Back to list

Click the··· icon in the upper right corner of a comment, selectCopy link, and the number at the end of the url iscomment_id.

⏫ Back to list

• You can directly use thisGitHub Actions workflow template repositorie template
• Personal exercises and testsActions repository
• Can also refer to the warehouse ofonline users

MIT