actions-cool/issues-helper

Fork 0

mirror of https://gitea.com/Lydanne/issues-helper.git synced 2025-08-19 18:25:58 +08:00

Files

xrkffgg a219a712d5 docs: fix name

2020-12-23 22:20:28 +08:00

22 KiB

Raw Permalink Blame History

🤖 Issues Helper

English | 简体中文

一个帮你处理 issues 的 GitHub Action

😎 为什么用 GitHub Action？

完全免费。
全自动操作。
托管于 GitHub 服务器，只要 GitHub 不宕机，它就会一直跑下去。

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

列表

⭐ 基础
⭐ 进阶
🌰 例子
- 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/issues-helper@v1
        with:
          actions: 'add-assignees'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          assignees: 'xxx' or ['xxx'] or ['xx1', 'xx2']

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
assignees	指定人。当不填或者为空字符、空数组时，不操作	string \| string[]	✖	v1

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

⏫ 返回列表

`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/issues-helper@v1
        with:
          actions: 'add-labels'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          labels: 'bug' or ['bug'] or ['bug1', 'bug2']

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
labels	新增的 labels。当不填或者为空字符、空数组时，不新增	string \| string[]	✖	v1

⏫ 返回列表

`close-issue`

关闭指定 issue。

- name: Close issue
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'close-issue'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: xxx
      body: 'This is auto closed.'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1

⏫ 返回列表

`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/issues-helper@v1
        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']

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
body	新增评论的内容	string	✖	v1
contents	为新增评论的增加 reaction	string \| string[]	✖	v1

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

⏫ 返回列表

`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/issues-helper@v1
        with:
          actions: 'create-issue'
          token: ${{ secrets.GITHUB_TOKEN }}
          title: 'xxxx'
          body: 'xxxx'
          labels: 'xx'
          assignees: 'xxx'
          contents: '+1'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
title	新增 issue 的标题	string	✖	v1
body	新增 issue 的内容	string	✖	v1
labels	为新增 issue 添加 labels	string \| string[]	✖	v1
assignees	为新增 issue 添加 assignees	string \| string[]	✖	v1
contents	为新增 issue 增加 reaction	string \| string[]	✖	v1

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

⏫ 返回列表

`delete-comment`

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

- name: Delete comment
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'delete-comment'
      token: ${{ secrets.GITHUB_TOKEN }}
      comment-id: xxx

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
comment-id	指定的 comment	number	✔	v1

⏫ 返回列表

`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/issues-helper@v1
        with:
          actions: 'lock-issue'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1

⏫ 返回列表

`open-issue`

打开指定 issue。

- name: Open issue
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'open-issue'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: xxx

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1

⏫ 返回列表

`remove-assignees`

移除 issue 指定人员。

- name: Remove assignees
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'remove-assignees'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}
      assignees: 'xx'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
assignees	移除的指定人。当为空字符、空数组时，不进行移除	string \| string[]	✔	v1

⏫ 返回列表

`set-labels`

替换 issue 的 labels。

- name: Set labels
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'set-labels'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}
      labels: 'xx'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
labels	labels 设置。当空字符、空数组时，会移除所有	string \| string[]	✔	v1

⏫ 返回列表

`unlock-issue`

解锁指定 issue。

- name: Unlock issue
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'unlock-issue'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: ${{ github.event.issue.number }}

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1

⏫ 返回列表

`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/issues-helper@v1
          with:
            actions: 'update-comment'
            token: ${{ secrets.GITHUB_TOKEN }}
            comment-id: ${{ github.event.comment.id }}
            contents: 'eyes'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
comment-id	指定的 comment	number	✔	v1
body	更新 comment 的内容	string	✖	v1
update-mode	更新模式。默认 `replace` 替换，`append` 附加	string	✖	v1
contents	增加 reaction	string \| string[]	✖	v1

body 不填时，会保持原有
update-mode 为 append 时，会进行附加操作。非 append 都会进行替换。仅对 body 生效

⏫ 返回列表

`update-issue`

根据 issue-number 更新指定 issue。

- name: Update issue
    uses: actions-cool/issues-helper@v1
    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'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
state	修改 issue 的状态，可选值 `open` `closed`	string	✖	v1
title	修改 issue 的标题	string	✖	v1
body	修改 issue 的内容	string	✖	v1
update-mode	更新模式。默认 `replace` 替换，`append` 附加	string	✖	v1
labels	替换 issue 的 labels	string \| string[]	✖	v1
assignees	替换 issue 的 assignees	string \| string[]	✖	v1
contents	增加 reaction	string \| string[]	✖	v1

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

⏫ 返回列表

⭐ 进阶

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

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
body	操作 issue 时，可进行评论。不填时，不评论	string	✖	v1
labels	标签筛选	string \| string[]	✖	v1
issue-state	状态筛选	string	✖	v1
issue-assignee	指定人筛选	string	✖	v1
issue-creator	创建人筛选	string	✖	v1
issue-mentioned	提及人筛选	string	✖	v1
body-includes	包含内容筛选	string	✖	v1
title-includes	包含标题筛选	string	✖	v1
inactive-day	非活跃天数筛选	number	✖	v1
inactive-label	新增标签名称	string	✖	v1

labels：为多个时，会查询同时拥有多个。不填时，会查询所有
issue-state：默认为 all。可选值 open closed，非这 2 项时，均为 all
issue-assignee：不支持多人。不填或输入 * 时，查询所有。输入 none 会查询未添加指定人的 issues
inactive-day：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
inactive-label：默认为 inactive，可自定义其他。当项目未包含该 label 时，会自动新建

`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@v1
        with:
          actions: 'close-issues'
          token: ${{ secrets.GITHUB_TOKEN }}
          labels: 'need info'
          inactive-day: 7

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
body	操作 issue 时，可进行评论。不填时，不评论	string	✖	v1
labels	标签筛选	string \| string[]	✖	v1
issue-assignee	指定人筛选	string	✖	v1
issue-creator	创建人筛选	string	✖	v1
issue-mentioned	提及人筛选	string	✖	v1
body-includes	包含内容筛选	string	✖	v1
title-includes	包含标题筛选	string	✖	v1
inactive-day	非活跃天数筛选	number	✖	v1

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

⏫ 返回列表

`find-comments`

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

- name: Find comments
    uses: actions-cool/issues-helper@v1
    with:
      actions: 'find-comments'
      token: ${{ secrets.GITHUB_TOKEN }}
      issue-number: 1
      comment-auth: 'k'
      body-includes: 'this'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
issue-number	指定的 issue	number	✔	v1
comment-auth	评论创建者，不填时会查询所有	string	✖	v1
body-includes	评论内容包含过滤，不填时无校验	string	✖	v1
direction	返回 `comments` 排序	string	✖	v1

返回 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@v1
        with:
          actions: 'lock-issues'
          token: ${{ secrets.GITHUB_TOKEN }}
          labels: 'inactive'
          inactive-day: 128

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1
token	token 说明	string	✔	v1
body	操作 issue 时，可进行评论。不填时，不评论	string	✖	v1
labels	标签筛选	string \| string[]	✖	v1
issue-state	状态筛选	string	✖	v1
issue-assignee	指定人筛选	string	✖	v1
issue-creator	创建人筛选	string	✖	v1
issue-mentioned	提及人筛选	string	✖	v1
body-includes	包含内容筛选	string	✖	v1
title-includes	包含标题筛选	string	✖	v1
inactive-day	非活跃天数筛选	number	✖	v1

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

⏫ 返回列表

🌰 例子

灵活参考。

`find-comments + create-comment + update-comment`

假设场景：当添加了 watch label 的 issue 修改时，查找是否有 k 创建的包含 error 的评论，如果只有一个，则更新该 comment，如果没有，则新增一个 comment。

name: Test

on:
  isssue:
    types: [edited]

jobs:
  do-test:
    runs-on: ubuntu-latest
    if: github.event.label.name == 'watch'
    steps:
      - name: find comments
        uses: actions-cool/issues-helper@v1
        id: fcid
        with:
          actions: 'find-comments'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          comment-auth: k
          body-includes: 'error'

      - name: create comment
        if: ${{ steps.fcid.outputs.comments.length == 0 }}
        uses: actions-cool/issues-helper@v1
        with:
          actions: 'create-comment'
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
          body: 'Some error!'

      - name: update comment
        if: ${{ steps.fcid.outputs.comments.length == 1 }}
        uses: actions-cool/issues-helper@v1
        with:
          actions: 'update-comment'
          token: ${{ secrets.GITHUB_TOKEN }}
          comment-id: ${{ steps.fcid.outputs.comments[0].id }}
          body: 'Some error again!'
          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-actions bot。

⏫ 返回列表

`outputs` 使用

- name: Create issue
  uses: actions-cool/issues-helper@v1
  id: createissue
  with:
    actions: 'create-issue'
    token: ${{ secrets.GITHUB_TOKEN }}
- name: Check outputs
  run: echo "Outputs issue_number is ${{ steps.createissue.outputs.issue-number }}"

GitHub Docs

⏫ 返回列表

Reactions types

content	emoji
`+1`	👍
`-1`	👎
`laugh`	😄
`confused`	😕
`heart`	❤️
`hooray`	🎉
`rocket`	🚀
`eyes`	👀

⏫ 返回列表

`comment-id`

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

⏫ 返回列表

Actions 模板

GitHub Actions workflow template Fork 后，可直接使用模板。

💖 谁在使用？

你可以来以下项目参考模版。欢迎在这里留言。

LICENSE

MIT

22 KiB Raw Permalink Blame History Unescape Escape

🤖 Issues Helper

😎 为什么用 GitHub Action？

列 表

🚀 使 用

⭐ 基 础

add-assignees

add-labels

close-issue

create-comment

create-issue

delete-comment

lock-issue

open-issue

remove-assignees

set-labels

unlock-issue

update-comment

update-issue

⭐ 进 阶

check-inactive

close-issues

find-comments

lock-issues

🌰 例 子

find-comments + create-comment + update-comment

🎁 参 考

token

outputs 使用

GitHub Docs

Reactions types

comment-id

Actions 模板

💖 谁在使用？

LICENSE

22 KiB

Raw Permalink Blame History

列表

🚀 使用

⭐ 基础

`add-assignees`

`add-labels`

`close-issue`

`create-comment`

`create-issue`

`delete-comment`

`lock-issue`

`open-issue`

`remove-assignees`

`set-labels`

`unlock-issue`

`update-comment`

`update-issue`

⭐ 进阶

`check-inactive`

`close-issues`

`find-comments`

`lock-issues`

🌰 例子

`find-comments + create-comment + update-comment`

🎁 参考

`outputs` 使用

`comment-id`