Advanced usage is not recommended to use multiple actions at the same time.
check-inactive
At UTC 0 on the 1st of each month, add the inactive
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@v2with:actions: 'check-inactive'token: ${{ secrets.GITHUB_TOKEN }}inactive-day: 30
Param | Desc | Type | Required |
---|---|---|---|
actions | Action type | string | β |
token | Token explain | string | β |
body | When operating an issue, you can comment. Do not comment when not typing | string | β |
contents | Add reaction for this comment | string | β |
labels | Labels filtering | string | β |
issue-state | State filtering | string | β |
issue-assignee | Assignee filtering | string | β |
issue-creator | Creator filtering | string | β |
issue-mentioned | Mentioned filtering | string | β |
body-includes | Body filtering | string | β |
title-includes | Title filtering | string | β |
inactive-day | Inactive days filtering | number | β |
inactive-label | The label name adding | string | β |
exclude-labels | Exclude labels filtering | string | β |
labels
: When there are multiple, the query will have multiple at the same time. If not entered, allissue-state
: The default is all
. Optional value open
closed
, when these 2 items are not, both are all
issue-assignee
: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering none
will query issues for which the specified person is not addedinactive-day
: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, allinactive-label
: The default is inactive
, others can be customized. When the project does not contain the label, it will be created automaticallycheck-issue
Check whether the issue meets the conditions according to the passed parameters and issue-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 contains x1
or x2
.
If one designated person is satisfied, the verification will pass, and at the same time, verify whether the title meets the conditions.
name: Check Issueon:issues:types: [edited]jobs:check-issue:runs-on: ubuntu-lateststeps:- name: check-issueuses: actions-cool/issues-helper@v2with:actions: 'check-issue'token: ${{ secrets.GITHUB_TOKEN }}issue-number: ${{ github.event.issue.number }}assignee-includes: 'x1,x2'title-includes: 'x1,x2/y1,y2'
Param | Desc | Type | Required |
---|---|---|---|
actions | Action type | string | β |
token | Token explain | string | β |
issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | β |
assignee-includes | Assignees contains check | string | β |
title-includes | Title contains check | string | β |
title-excludes | Check whether the title is empty after removing the default title | string | β |
body-includes | Body contains check | string | β |
title-includes
body-includes
supports the format x1,x2
or x1,x2/y1,y2
. Only supports two levelscheck-result
, due to yml reasons, the judgment condition is if: steps.xxid.outputs.check-result =='true'
close-issues
Every 7 days at UTC 0, close the issues that have been filled with the need 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@v2with:actions: 'close-issues'token: ${{ secrets.GITHUB_TOKEN }}labels: 'need info'inactive-day: 7
Param | Desc | Type | Required |
---|---|---|---|
actions | Action type | string | β |
token | Token explain | string | β |
body | When operating an issue, you can comment. Do not comment when not typing | string | β |
contents | Add reaction for this comment | string | β |
labels | Labels filtering | string | β |
issue-assignee | Assignee filtering | string | β |
issue-creator | Creator filtering | string | β |
issue-mentioned | Mentioned filtering | string | β |
body-includes | Body filtering | string | β |
title-includes | Title filtering | string | β |
inactive-day | Inactive days filtering | number | β |
exclude-labels | Exclude labels filtering | string | β |
labels
: When there are multiple, the query will have multiple at the same time. If not entered, allissue-assignee
: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering none
will query issues for which the specified person is not addedinactive-day
: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, allfind-comments
Find the current warehouse issue No. 1, the creator is k and the content contains the comment list of this
.
- name: Find commentsuses: actions-cool/issues-helper@v2with:actions: 'find-comments'token: ${{ secrets.GITHUB_TOKEN }}issue-number: 1comment-auth: 'k'body-includes: 'this'
Param | Desc | Type | Required |
---|---|---|---|
actions | Action type | string | β |
token | Token explain | string | β |
issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | β |
comment-auth | Comment creator, all will be queried if not filled | string | β |
body-includes | Comment content includes filtering, no verification if not filled | string | β |
direction | Return comments sort | string | β |
comments
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 when desc
is set, descending order will be returnedcreated
updated
in the returned array, determined by the environment, will be UTC +0lock-issues
Every 3 months at UTC 0 on the 1st, lock all issues that have been filled with the inactive
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@v2with:actions: 'lock-issues'token: ${{ secrets.GITHUB_TOKEN }}labels: 'inactive'inactive-day: 128
Param | Desc | Type | Required |
---|---|---|---|
actions | Action type | string | β |
token | Token explain | string | β |
body | When operating an issue, you can comment. Do not comment when not typing | string | β |
contents | Add reaction for this comment | string | β |
labels | Labels filtering | string | β |
issue-state | State filtering | string | β |
issue-assignee | Assignee filtering | string | β |
issue-creator | Creator filtering | string | β |
issue-mentioned | Mentioned filtering | string | β |
body-includes | Body filtering | string | β |
title-includes | Title filtering | string | β |
inactive-day | Inactive days filtering | number | β |
lock-reason | Reason for locking issue | string | β |
exclude-labels | Exclude labels filtering | string | β |
labels
: When there are multiple, the query will have multiple at the same time. If not entered, allissue-state
: The default is all
. Optional value open
closed
, when these 2 items are not, both are all
issue-assignee
: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering none
will query issues for which the specified person is not addedinactive-day
: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, allmonth-statistics
At 1 o'clock on the 1st of each month, an issue is generated for the statistics of the previous month.
name: Issue Month Statisticson:schedule:- cron: "0 1 1 * *"jobs:month-statistics:runs-on: ubuntu-lateststeps:- name: month-statisticsuses: actions-cool/issues-helper@v2with:actions: 'month-statistics'token: ${{ secrets.GITHUB_TOKEN }}count-lables: 'true'
Param | Desc | Type | Required |
---|---|---|---|
actions | Action type | string | β |
token | Token explain | string | β |
labels | The labels for the new issue | string | β |
assignees | The assignees for the new issue | string | β |
count-lables | Whether the new issue count labels | string | β |
count-comments | Whether the new issue count comments | string | β |
[Current repo] Month Statistics: Year-Month
count-lables
: You can set 'true'
to add labels statisticscount-comments
: You can set 'true'
to add comments statisticsAs follows: