🌟 进 阶

进阶用法不建议 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@v2.2.1
with:
actions: 'check-inactive'
token: ${{ secrets.GITHUB_TOKEN }}
inactive-day: 30
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✔
body操作 issue 时,可进行评论。不填时,不评论string✖
contents为该评论增加 reactionstring✖
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✖
  • labels:为多个时,会查询同时拥有多个。不填时,会查询所有
  • issue-state:默认为 all。可选值 open closed,非这 2 项时,均为 all
  • issue-assignee:不支持多人。不填或输入 * 时,查询所有。输入 none 会查询未添加指定人的 issues
  • inactive-day:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
  • inactive-label:默认为 inactive,可自定义其他。当项目未包含该 label 时,会自动新建

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@v2.2.1
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指定的 issuenumber✔
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@v2.2.1
with:
actions: 'close-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'need info'
inactive-day: 7
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✔
body操作 issue 时,可进行评论。不填时,不评论string✖
contents为该评论增加 reactionstring✖
labels标签筛选string✖
issue-assignee指定人筛选string✖
issue-creator创建人筛选string✖
issue-mentioned提及人筛选string✖
body-includes包含内容筛选string✖
title-includes包含标题筛选string✖
inactive-day非活跃天数筛选number✖
  • labels:为多个时,会查询同时拥有多个。不填时,会查询所有
  • issue-assignee:不支持多人。不填或输入 * 时,查询所有。输入 none 会查询未添加指定人的 issues
  • inactive-day:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有

find-comments

查找当前仓库 1 号 issue 中,创建者是 k ,内容包含 this 的评论列表。

- name: Find comments
uses: actions-cool/issues-helper@v2.2.1
with:
actions: 'find-comments'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: 1
comment-auth: 'k'
body-includes: 'this'
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✔
issue-number指定的 issuenumber✔
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

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@v2.2.1
with:
actions: 'lock-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'inactive'
inactive-day: 128
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✔
body操作 issue 时,可进行评论。不填时,不评论string✖
contents为该评论增加 reactionstring✖
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✖
  • labels:为多个时,会查询同时拥有多个。不填时,会查询所有
  • issue-state:默认为 all。可选值 open closed,非这 2 项时,均为 all
  • issue-assignee:不支持多人。不填或输入 * 时,查询所有。输入 none 会查询未添加指定人的 issues
  • inactive-day:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有

month-statistics

每月 1 号 1 时,生成一个 issue 上月统计。

name: Issue Month Statistics
on:
schedule:
- cron: "0 1 1 * *"
jobs:
month-statistics:
runs-on: ubuntu-latest
steps:
- name: month-statistics
uses: actions-cool/issues-helper@v2.2.1
with:
actions: 'month-statistics'
token: ${{ secrets.GITHUB_TOKEN }}
count-lables: 'true'
参数描述类型必填
actions操作类型string✔
tokentoken 说明string✔
labels为新增 issue 添加 labelsstring✖
assignees为新增 issue 添加 assigneesstring✖
count-lables新增 issue 是否统计 labelsstring✖
count-comments新增 issue 是否统计 commentsstring✖
  • 新增 issue 的标题默认为 [当前仓库] Month Statistics: å¹´-月
  • count-lables:可设置 'true',增加 labels 统计
  • count-comments:可设置 'true',增加 comments 统计

如下所示: