🤖 Issues 助手

简体中文 | English

一个轻松帮你自动管理 issues 的 GitHub Action

在线文档 | 更新日志 | 国内镜像

😎 为什么用 GitHub Action？

1. 完全免费
2. 全自动操作
3. 托管于 GitHub 服务器，只要 GitHub 不宕机，它就不受影响

Private 项目每月有 2000 次的限制，具体查看。Public 项目无限制。

谁在使用？

欢迎在 这里 留言。

ant-design	ant-design-blazor	ant-design-vue	dumi
jsx-next	material-ui	prettier	pro-components
react-component	react-music-player	umi	vite
vue-request	zoo

⚡ 反馈

非常欢迎你来尝试使用，并提出意见，你可以通过以下方式：

• 通过 Issue 报告 bug 或进行咨询
• 通过 Discussions 进行讨论
• 提交 Pull Request 改进 issues-helper 的代码

也欢迎加入 钉钉交流群

列 表

当以下列表没有你想要的功能时，可以在 What do you want? 中提出。

• ⭐ 基 础
  • add-assignees
  • add-labels
  • close-issue
  • create-comment
  • create-issue
  • create-label
  • delete-comment
  • lock-issue
  • mark-duplicate
  • open-issue
  • remove-assignees
  • remove-labels
  • set-labels
  • unlock-issue
  • update-comment
  • update-issue
  • welcome
• 🌟 进 阶
  • check-inactive
  • check-issue
  • close-issues
  • find-comments
  • lock-issues
  • month-statistics
• 🌰 例 子
  • find-comments + create-comment + update-comment

🚀 使 用

⭐ 基 础

为了更好的展示功能，下面以实际场景举例，请灵活参考。

add-assignees

当一个 issue 新增或修改时，将这个 issue 指定某人或多人。

name: Add Assigness

on:
  issues:
    types: [opened, edited]

jobs:
  add-assigness:
    runs-on: ubuntu-latest
    steps:
      - name: Add assigness
        uses: actions-cool/[email protected]
        with:
          actions: 'add-assignees'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          assignees: 'xxx' or 'xx1,xx2'
          random-to: 1

• actions 支持多个，需用逗号隔开。如：add-assignees,add-labels
• 其中的 name 可根据自行根据实际情况修改
• on 参考
• ${{ github.event.issue.number }} 表示当前 issue，更多参考
• assignees 支持多个，需用逗号隔开

⏫ 返回列表

add-labels

当一个新增的 issue 内容不包含指定格式时，为这个 issue 添加 labels。

name: Add Labels

on:
  issues:
    types: [opened]

jobs:
  add-labels:
    runs-on: ubuntu-latest
    if: contains(github.event.issue.body, 'xxx') == false
    steps:
      - name: Add labels
        uses: actions-cool/[email protected]
        with:
          actions: 'add-labels'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          labels: 'bug' or 'bug1,bug2'

• labels 支持多个，需用逗号隔开

⏫ 返回列表

close-issue

关闭指定 issue。

- name: Close issue
    uses: actions-cool/[email protected]
    with:
      actions: 'close-issue'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: xxx
      body: 'This is auto closed.'

⏫ 返回列表

create-comment

当新增一个指定 label 时，对该 issue 进行评论。

name: Create Comment

on:
  issues:
    types: [labeled]

jobs:
  create-comment:
    runs-on: ubuntu-latest
    if: github.event.label.name == 'xxx'
    steps:
      - name: Create comment
        uses: actions-cool/[email protected]
        with:
          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 }}。巴拉巴拉。
          contents: '+1' or '+1,heart'

• body 默认为：Currently at ${owner}/${repo}. And this is default comment.
  • 其中 ${owner}/${repo} 表示当前仓库
• 返回 comment-id，可用于之后操作。用法参考
• ${{ github.event.issue.user.login }} 表示该 issue 的创建者
• contents 支持多个，需用逗号隔开

⏫ 返回列表

create-issue

感觉新增 issue 使用场景不多。这里举例，每月 1 号 UTC 00:00 新增一个 issue。

name: Create Issue

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

jobs:
  create-issue:
    runs-on: ubuntu-latest
    steps:
      - name: Create issue
        uses: actions-cool/[email protected]
        with:
          actions: 'create-issue'
          token: ${{ secrets.GITHUB_TOKEN }}
          title: 'xxxx'
          body: 'xxxx'
          labels: 'xx'
          assignees: 'xxx'
          contents: '+1'

• title 默认为：Default Title
• 返回 issue-number，用法参考

⏫ 返回列表

create-label

新增 label。若想批量维护 labels，可查看。

- name: Create label
  uses: actions-cool/[email protected]
  with:
    actions: 'create-label'
    token: ${{ secrets.GITHUB_TOKEN }}
    label-name: 'xx'
    label-color: '0095b3'
    label-desc: 'xx'

• label-name：若已存在，则无操作
• label-color：默认为 ededed

⏫ 返回列表

delete-comment

根据 comment-id 删除指定评论。

- name: Delete comment
    uses: actions-cool/[email protected]
    with:
      actions: 'delete-comment'
      token: ${{ secrets.GITHUB_TOKEN }}
      comment-id: xxx

• 当 out-comments 输入时，comment-id 不起作用

⏫ 返回列表

lock-issue

当新增 invalid label 时，对该 issue 进行锁定。

name: Lock Issue

on:
  issues:
    types: [labeled]

jobs:
  lock-issue:
    runs-on: ubuntu-latest
    if: github.event.label.name == 'invalid'
    steps:
      - name: Lock issue
        uses: actions-cool/[email protected]
        with:
          actions: 'lock-issue'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}

• lock-reason：可选值有 off-topic too heated resolved spam

⏫ 返回列表

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/[email protected]
        with:
          actions: 'mark-duplicate'
          token: ${{ secrets.GITHUB_TOKEN }}

• duplicate-command：当设置简洁命令时，同时仍支持原有 Duplicate of。屏蔽内容包含 ?
• labels：优先级最高
• close-issue：true 或 'true' 均可生效
• require-permission：可选值有 admin，write，read，none
  • 团队成员若设置 read 权限，则为 read
  • 外部 Collaborator 若设置 read 权限，则为 read
  • 普通用户为 read 权限
  • 当设置 write 后，admin 和 write 满足条件

⏫ 返回列表

open-issue

打开指定 issue。

- name: Open issue
    uses: actions-cool/[email protected]
    with:
      actions: 'open-issue'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: xxx

⏫ 返回列表

remove-assignees

移除 issue 指定人员。

- name: Remove assignees
    uses: actions-cool/[email protected]
    with:
      actions: 'remove-assignees'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}
      assignees: 'xx'

⏫ 返回列表

remove-labels

移除指定 labels。

- name: Remove labels
    uses: actions-cool/[email protected]
    with:
      actions: 'remove-labels'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}
      labels: 'xx'

• labels 支持多个，如 x1,x2,x3，只会移除 issue 已添加的 labels

⏫ 返回列表

set-labels

替换 issue 的 labels。

- name: Set labels
    uses: actions-cool/[email protected]
    with:
      actions: 'set-labels'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}
      labels: 'xx'

⏫ 返回列表

unlock-issue

解锁指定 issue。

- name: Unlock issue
    uses: actions-cool/[email protected]
    with:
      actions: 'unlock-issue'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}

⏫ 返回列表

update-comment

根据 comment-id 更新指定评论。

下面的例子展示的是，为每个新增的 comment 增加 👀 。

name: Add eyes to each comment

on:
  issue_comment:
    types: [created]

jobs:
  update-comment:
    runs-on: ubuntu-latest
    steps:
      - name: Update comment
          uses: actions-cool/[email protected]
          with:
            actions: 'update-comment'
            token: ${{ secrets.GITHUB_TOKEN }}
            comment-id: ${{ github.event.comment.id }}
            contents: 'eyes'

• body 不填时，会保持原有
• update-mode 为 append 时，会进行附加操作。非 append 都会进行替换。仅对 body 生效
• 当 out-comments 输入时，comment-id 不起作用

⏫ 返回列表

update-issue

根据 issue-number 更新指定 issue。

- name: Update issue
    uses: actions-cool/[email protected]
    with:
      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'
      contents: '+1'

• state 默认为 open
• 当可选项不填时，会保持原有

⏫ 返回列表

welcome

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

name: Issue Welcome

on:
  issues:
    types: [opened]

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

• 若这 4 个可选项都不填，则无操作

⏫ 返回列表

🌟 进 阶

进阶用法不建议 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/[email protected]
        with:
          actions: 'check-inactive'
          token: ${{ secrets.GITHUB_TOKEN }}
          inactive-day: 30

• labels：为多个时，会查询同时拥有多个。不填时，会查询所有
• issue-state：默认为 open。可选值 all closed，非这 2 项时，均为 open
• 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/[email protected]
        with:
          actions: 'check-issue'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          assignee-includes: 'x1,x2'
          title-includes: 'x1,x2/y1,y2'

• 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/[email protected]
        with:
          actions: 'close-issues'
          token: ${{ secrets.GITHUB_TOKEN }}
          labels: 'need info'
          inactive-day: 7

• labels：为多个时，会查询同时拥有多个。不填时，会查询所有
• issue-assignee：不支持多人。不填或输入 * 时，查询所有。输入 none 会查询未添加指定人的 issues
• inactive-day：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有

⏫ 返回列表

find-comments

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

- name: Find comments
    uses: actions-cool/[email protected]
    with:
      actions: 'find-comments'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: 1
      comment-auth: 'k'
      body-includes: 'this'

• 返回 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/[email protected]
        with:
          actions: 'lock-issues'
          token: ${{ secrets.GITHUB_TOKEN }}
          labels: 'inactive'
          inactive-day: 128

• labels：为多个时，会查询同时拥有多个。不填时，会查询所有
• issue-state：默认为 open。可选值 all closed，非这 2 项时，均为 open
• 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/[email protected]
        with:
          actions: 'month-statistics'
          token: ${{ secrets.GITHUB_TOKEN }}
          count-lables: 'true'

• 新增 issue 的标题默认为 [当前仓库] Month Statistics: 年-月
• count-lables：可设置 'true'，增加 labels 统计
• count-comments：可设置 'true'，增加 comments 统计

⏫ 返回列表

🌰 例 子

灵活参考。

find-comments + create-comment + update-comment

假设场景：当添加了 watch label 的 issue 修改时，查找是否有 k 创建的包含 <!-- Created by actions-cool/issues-helper --> 的评论，如果有，则更新 comment，如果没有，则新增一个 comment。

当然，如果你需要这样的场景，可以直接使用 Maintain One Comment。

name: Test

on:
  issues:
    types: [edited]

jobs:
  do-test:
    runs-on: ubuntu-latest
    if: github.event.label.name == 'watch'
    steps:
      - name: find comments
        uses: actions-cool/[email protected]
        id: fcid
        with:
          actions: 'find-comments'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          comment-auth: k
          body-includes: '<!-- Created by actions-cool/issues-helper -->'

      # 输出查看找到的内容。GitHub 默认 outputs 为字符串
      - run: echo find-comments ${{ steps.fcid.outputs.comments }}
        shell: bash

      - name: create comment
        if: contains(steps.fcid.outputs.comments, '<!-- Created by actions-cool/issues-helper -->') == false
        uses: actions-cool/[email protected]
        with:
          actions: 'create-comment'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          body: |
            Error
            <!-- Created by actions-cool/issues-helper -->

      - name: update comment
        if: contains(steps.fcid.outputs.comments, '<!-- Created by actions-cool/issues-helper -->') == true
        uses: actions-cool/[email protected]
        with:
          actions: 'update-comment'
          token: ${{ secrets.GITHUB_TOKEN }}
          out-comments: ${{ steps.fcid.outputs.comments }}
          body: |
            Error Again
            <!-- Created by actions-cool/issues-helper -->
          update-mode: 'append'

⏫ 返回列表

🎁 参 考

token

需拥有 push 权限的人员 token。

• 个人 token 申请
  • 需勾选 Full control of private repositories
• 项目添加 secrets
  • 选择 settings，选择 secrets，选择 New repository secret
  • Name 与 actions 中保持一致
  • Value 填写刚才个人申请的 token

当 actions 不填写 token 时，或填写 ${{ secrets.GITHUB_TOKEN }}，会默认为 github-actions-bot。更多查看。

⏫ 返回列表

GitHub Docs

• GitHub Actions 语法
• 工作流触发机制

⏫ 返回列表

outputs 使用

- name: Create issue
  uses: actions-cool/[email protected]
  id: createissue
  with:
    actions: 'create-issue'
    token: ${{ secrets.GITHUB_TOKEN }}
- name: Check outputs
  run: echo "Outputs issue_number is ${{ steps.createissue.outputs.issue-number }}"

更多查看：

1. https://docs.github.com/en/[email protected]/actions/creating-actions/metadata-syntax-for-github-actions#outputs
2. https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idoutputs

⏫ 返回列表

校验规则

"title-includes": 'x1,x2'

x1
x2

"x1y3y2"  true
"y2 x1"   true
"x2"      true
"x3"      false

"title-includes": 'x1,x2/y1,y2'

x1 + y1
x2 + y1
x1 + y2
x2 + y2

"x1y3y2"  true
"y2 x1"   true
"1x2y"    false
"x1"      false

⏫ 返回列表

Reactions 类型

⏫ 返回列表

comment-id

点击某个评论右上角 ··· 图标，选择 Copy link，url 末尾数字即是 comment_id。

⏫ 返回列表

✨ 版本

• 版本规则

  • 采用两级语义化版本，如v1、v1.1、v2、v2.1
  • v1 表示初始版本
  • 对 v1 版本的修复和新增会发布到 v1.1 版本
  • 当发布的 v1.x 运行一定时间稳定或进行重构时，发布进阶 v2 版本
  • v2 版本后会严格按照三级语义来发布版本，如 v2.0.0、v2.1.0

• 版本选择

  • 建议采用最新 releases 版本。可在 releases 看到
  • 同时也可参照下面的更新日志来选择版本
  • 最新的 v1.x release 代码会合并到 1.x 分支中
  • 支持直接使用分支版本。如：

- name: Issues Helper
  uses: actions-cool/[email protected]

# or

- name: Issues Helper
  uses: actions-cool/[email protected]

• v2 升级参考

Actions 模板

• 可直接使用这个 GitHub Actions workflow template 仓库的模板
• 个人练习和测试 Actions 的仓库
• 也可以来 线上使用者 的仓库参照

LICENSE

MIT