Issues Helper

English

🌟 进 阶

进阶用法不建议 actions 多个一次同时使用。

check-inactive

每月 1 号 UTC 0 时，对所有 30 天以上未活跃的 issues 增加 inactive 标签。

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
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
body操作 issue 时，可进行评论。不填时，不评论string✖
emoji为该评论增加 emojistring✖
labels标签筛选string✖
issue-state状态筛选string✖
issue-assignee指定人筛选string✖
issue-creator创建人筛选string✖
issue-mentioned提及人筛选string✖
body-includes包含内容筛选string✖
title-includes包含标题筛选string✖
inactive-day非活跃天数筛选number✖
inactive-label新增标签名称string✖
exclude-labels排除标签筛选string✖
  • labels：为多个时，会查询同时拥有多个。不填时，会查询所有
  • issue-state：默认为 all。可选值 open closed，非这 2 项时，均为 all
  • issue-assignee：不支持多人。不填或输入 * 时，查询所有。输入 none 会查询未添加指定人的 issues
  • inactive-day：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
  • inactive-label：默认为 inactive，可自定义其他。当项目未包含该 label 时，会自动新建
  • exclude-labels：设置包含 $exclude-empty 时，可排除无 label issue

check-issue

根据传入的参数和 issue-number 来检查该 issue 是否满足条件，返回一个布尔值。

下面的例子效果是：当 issue 新开时，校验当前 issue 指定人是否包含 x1 或者 x2，满足一个指定人即可校验通过，同时校验标题是否满足条件，校验规则。

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'
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
issue-number指定的 issue，当不传时会从触发事件中获取number✖
assignee-includes是否包含指定人string✖
title-includes标题包含校验string✖
title-excludes检测标题移除默认 title 后是否为空string✖
body-includes内容包含校验string✖
  • title-includes body-includes 支持格式 x1,x2 或者 x1,x2/y1,y2。只支持两个层级
  • 返回 check-result，由于 yml 原因，判断条件为 if: steps.xxid.outputs.check-result == 'true'

close-issues

每 7 天 UTC 0 时，关闭已填加 need info label 且 7 天以上未活跃的 issues。

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
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
body操作 issue 时，可进行评论。不填时，不评论string✖
emoji为该评论增加 emojistring✖
labels标签筛选string✖
issue-assignee指定人筛选string✖
issue-creator创建人筛选string✖
issue-mentioned提及人筛选string✖
body-includes包含内容筛选string✖
title-includes包含标题筛选string✖
inactive-day非活跃天数筛选number✖
exclude-labels排除标签筛选string✖
close-reason关闭原因。默认not_planned未计划，completed完成string✖
  • labels：为多个时，会查询同时拥有多个。不填时，会查询所有
  • issue-assignee：不支持多人。不填或输入 * 时，查询所有。输入 none 会查询未添加指定人的 issues
  • inactive-day：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
  • exclude-labels：设置包含 $exclude-empty 时，可排除无 label issue

find-comments

查找当前仓库 1 号 issue 中，创建者是 k ，内容包含 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'
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
issue-number指定的 issue，当不传时会从触发事件中获取number✖
comment-auth评论创建者，不填时会查询所有string✖
body-includes评论内容包含过滤，不填时无校验string✖
direction返回 comments 排序string✖
  • 返回 comments，格式如下：
[
  {id: 1, auth: 'x', body: 'xxx', created: '', updated: ''},
  {id: 2, auth: 'x', body: 'xxx', created: '', updated: ''},
]
  • direction 默认为升序，只有设置 desc 时，会返回降序
  • 返回数组中 created updated，由所处环境决定，会是 UTC +0

find-issues

查找当前仓库，创建者是 k ，title 包含 this ，body 包含 that，打开状态的 issues 列表。

- 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'
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
issue-state状态筛选string✖
issue-creator创建者筛选string✖
title-includes标题包含过滤，不填时无校验string✖
body-includes内容包含过滤，不填时无校验string✖
exclude-labels排除标签筛选string✖
inactive-day非活跃天数筛选number✖
direction返回 issues 排序string✖
  • 返回 issues，格式如下：
[
  {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 默认为升序，只有设置 desc 时，会返回降序
  • 返回数组中 created updated，由所处环境决定，会是 UTC +0
  • exclude-labels：设置包含 $exclude-empty 时，可排除无 label issue

lock-issues

每 3 个月 1 号 UTC 0 时，锁定已填加 inactive label 且 128 天以上未活跃的所有 issues。

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
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
body操作 issue 时，可进行评论。不填时，不评论string✖
emoji为该评论增加 emojistring✖
labels标签筛选string✖
issue-state状态筛选string✖
issue-assignee指定人筛选string✖
issue-creator创建人筛选string✖
issue-mentioned提及人筛选string✖
body-includes包含内容筛选string✖
title-includes包含标题筛选string✖
inactive-day非活跃天数筛选number✖
lock-reason锁定 issue 的原因string✖
exclude-labels排除标签筛选string✖
  • labels：为多个时，会查询同时拥有多个。不填时，会查询所有
  • issue-state：默认为 all。可选值 open closed，非这 2 项时，均为 all
  • issue-assignee：不支持多人。不填或输入 * 时，查询所有。输入 none 会查询未添加指定人的 issues
  • inactive-day：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
  • exclude-labels：设置包含 $exclude-empty 时，可排除无 label issue

mark-assignees

快捷加指定人，仅作用于 issue 新增编辑评论。

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 }}
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
assign-command可设置简洁命令，如：/astring✖
require-permission要求权限，默认为 writestring✖
  • assign-command：可设置简洁命令。默认：/assign
  • require-permission：可选值有 admin，write，read，none
    • 团队成员若设置 read 权限，则为 read
    • 外部 Collaborator 若设置 read 权限，则为 read
    • 普通用户为 read 权限
    • 当设置 write 后，admin 和 write 满足条件

mark-duplicate

快捷标记重复问题，仅作用于 issue 新增编辑评论。

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 }}
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✖
duplicate-command可设置简洁命令，如：/dstring✖
duplicate-labels为该 issue 额外增加 labelsstring✖
remove-labels设置可移除的 labelsstring✖
labels替换该 issue 的 labelsstring✖
emoji为该评论的增加 emojistring✖
close-issue是否同时关闭该 issuestring✖
require-permission要求权限，默认为 writestring✖
close-reason关闭原因。默认not_planned未计划，completed完成string✖
  • duplicate-command：当设置简洁命令时，同时仍支持原有 Duplicate of。屏蔽内容包含 ?
  • labels：优先级最高
  • close-issue：true 或 'true' 均可生效
  • require-permission：可选值有 admin，write，read，none
    • 团队成员若设置 read 权限，则为 read
    • 外部 Collaborator 若设置 read 权限，则为 read
    • 普通用户为 read 权限
    • 当设置 write 后，admin 和 write 满足条件
注意：使用简洁命令创建的 Duplicate 不显示下图红框内容。但其实这个没有任何影响的。

welcome

当一个 issue 新建时，对首次新建 issue 的用户进行欢迎。若用户非首次新建，则无操作。

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'
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✔
body评论欢迎的内容，不填则不评论string✖
labels为该 issue 增加 labelsstring✖
assignees为该 issue 增加 assigneesstring✖
issue-emoji为该 issue 增加 emojistring✖
  • 若这 4 个可选项都不填，则无操作
在 GitHub 上编辑此页9/2/2022 09:03:22