issues-helper/docs/base.md

toc

toc
menu

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

⭐ 基 础

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 'xx1,xx2'

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

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

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 'bug1,bug2'

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

• labels 支持多个，需用逗号隔开。注意设置多个，需使用v1.1以上版本

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	✖	v1.1

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

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	✖	v1.1
assignees	为新增 issue 添加 assignees	string	✖	v1.1
contents	为新增 issue 增加 reaction	string	✖	v1.1

• 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	✔	v1.1

remove-labels

移除指定 labels。

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

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1.2
token	token 说明	string	✔	v1.2
issue-number	指定的 issue	number	✔	v1.2
labels	移除的 labels。当为空字符时，不进行移除	string	✔	v1.2

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

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	✔	v1.1

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	✖	v1.1

• 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	✖	v1.1
assignees	替换 issue 的 assignees	string	✖	v1.1
contents	增加 reaction	string	✖	v1.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/issues-helper@v1.3
        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'

参数	描述	类型	必填	版本
actions	操作类型	string	✔	v1.3
token	token 说明	string	✔	v1.3
body	评论欢迎的内容，不填则不评论	string	✖	v1.3
labels	为该 issue 增加 labels	string	✖	v1.3
assignees	为该 issue 增加 assignees	string	✖	v1.3
issue-contents	为该 issue 增加 reaction	string	✖	v1.3

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