issues-helper/web/docs/advanced.en-US.md

toc

toc
menu

🌟 Advanced

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 inactive

on:
  schedule:
    - cron: "0 0 1 * *"

jobs:
  check-inactive:
    runs-on: ubuntu-latest
    steps:
      - name: check-inactive
        uses: actions-cool/issues-helper@v3
        with:
          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, all
• issue-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 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 is inactive, 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

check-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.

Check rules

name: Check Issue

on:
  issues:
    types: [edited]

jobs:
  check-issue:
    runs-on: ubuntu-latest
    steps:
      - name: check-issue
        uses: actions-cool/issues-helper@v3
        with:
          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 levels
• Return check-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 info

on:
  schedule:
    - cron: "0 0 */7 * *"

jobs:
  check-need-info:
    runs-on: ubuntu-latest
    steps:
      - name: close-issues
        uses: actions-cool/issues-helper@v3
        with:
          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	✖
close-reason	Reason for closing. Default not_planned, another completed	string	✖

• 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. Entering none 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

find-comments

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

- name: Find comments
    uses: actions-cool/issues-helper@v3
    with:
      actions: 'find-comments'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: 1
      comment-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	✖

• Return 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 returned
• The created updated in the returned array, determined by the environment, will be UTC +0

find-issues

Find the current repository, the creator is k , the title contains this , the body contains that, and the list of issues in the open state.

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

Param	Desc	Type	Required
actions	Action type	string	✔
token	Token explain	string	✖
issue-state	State filtering	string	✖
issue-creator	Creator filtering	string	✖
title-includes	Title filtering	string	✖
body-includes	Body filtering	string	✖
exclude-labels	Exclude labels filtering	string	✖
inactive-day	Inactive days filtering	number	✖
direction	Return sort	string	✖

• Returns issues in the following format:

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

• direction defaults to ascending order, only when desc is set, descending order will be returned
• The created updated 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

lock-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 issues

on:
  schedule:
    - cron: "0 0 1 */3 *"

jobs:
  lock-issues:
    runs-on: ubuntu-latest
    steps:
      - name: lock-issues
        uses: actions-cool/issues-helper@v3
        with:
          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, all
• issue-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 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

mark-assignees

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

name: Issue Mark Assignees

on:
  issue_comment:
    types: [created, edited]

jobs:
  mark-assignees:
    runs-on: ubuntu-latest
    steps:
      - name: mark-assignees
        uses: actions-cool/issues-helper@v3
        with:
          actions: 'mark-assignees'
          token: ${{ secrets.GITHUB_TOKEN }}

Param	Desc	Type	Required
actions	Action type	string	✔
token	Token explain	string	✖
assign-command	Simple commands can be set, such as: /a	string	✖
require-permission	Permission required, default is write	string	✖

• assign-command: default /assign
• require-permission: Optional values are admin, write, read, none
  • If the team member sets the read permission, it is read
  • If the external Collaborator is set to read permission, it is read
  • Ordinary users have read permission
  • When set write, admin and write meet the conditions

mark-duplicate

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

name: Issue Mark Duplicate

on:
  issue_comment:
    types: [created, edited]

jobs:
  mark-duplicate:
    runs-on: ubuntu-latest
    steps:
      - name: mark-duplicate
        uses: actions-cool/issues-helper@v3
        with:
          actions: 'mark-duplicate'
          token: ${{ secrets.GITHUB_TOKEN }}

Param	Desc	Type	Required
actions	Action type	string	✔
token	Token explain	string	✖
duplicate-command	Simple commands can be set, such as: /d	string	✖
duplicate-labels	Add additional labels to this issue	string	✖
remove-labels	Set removable labels	string	✖
labels	Replace the labels of the issue	string	✖
emoji	Add emoji for this comment	string	✖
close-issue	Whether to close the issue at the same time	string	✖
require-permission	Permission required, default is write	string	✖
close-reason	Reason for closing. Default not_planned, another completed	string	✖

• duplicate-command: When setting concise commands, while still supporting the original Duplicate of. Block content contains ?
• labels: Highest priority
• close-issue: Both true or 'true' can take effect
• require-permission: Optional values are admin, write, read, none
  • If the team member sets the read permission, it is read
  • If the external Collaborator is set to read permission, it is read
  • Ordinary users have read permission
  • When set write, admin and write meet the conditions

Note: Duplicate created with the concise command does not display the content of the red box in the figure below. But in fact this has no effect.

welcome

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 Welcome

on:
  issues:
    types: [opened]

jobs:
  issue-welcome:
    runs-on: ubuntu-latest
    steps:
      - name: welcome
        uses: actions-cool/issues-helper@v3
        with:
          actions: 'welcome'
          token: ${{ secrets.GITHUB_TOKEN }}
          body: hi @${{ github.event.issue.user.login }}, welcome!
          labels: 'welcome1, welcome2'
          assignees: 'xx1'
          issue-emoji: '+1, -1, eyes'

Param	Desc	Type	Required
actions	Action type	string	✔
token	Token explain	string	✖
body	Comment on the welcome content, no comment if you leave it blank	string	✖
labels	Add labels to this issue	string	✖
assignees	Add assignees to this issue	string	✖
issue-emoji	Add emoji to this issue	string	✖

• If these 4 options are not filled, no operation