mirror of
https://gitea.com/Lydanne/issues-helper.git
synced 2025-08-20 02:35:58 +08:00
docs: up website & sh
This commit is contained in:
元凛
172
web/docs/base.md
172
web/docs/base.md
@@ -22,7 +22,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Add assigness
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'add-assignees'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -34,7 +34,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| assignees | 指定人。当不填或者为空字符时，不操作 | string | ✖ |
|
||||
| random-to | 当设置时，会在 assignees 中随机选择 | number | ✖ |
|
||||
@@ -44,6 +44,7 @@ jobs:
|
||||
- [on 参考](/guide/ref#-github-相关文档)
|
||||
- `${{ github.event.issue.number }}` 表示当前 issue，[更多参考](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events)
|
||||
- `assignees` 支持多个，需用逗号隔开
|
||||
- assign 最多只能设定 10 个
|
||||
|
||||
## `add-labels`
|
||||
|
||||
@@ -62,7 +63,7 @@ jobs:
|
||||
if: contains(github.event.issue.body, 'xxx') == false
|
||||
steps:
|
||||
- name: Add labels
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'add-labels'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -73,7 +74,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| labels | 新增的 labels。当不填或者为空字符时，不新增 | string | ✖ |
|
||||
|
||||
@@ -85,7 +86,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Close issue
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'close-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -95,7 +96,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
|
||||
## `create-comment`
|
||||
@@ -115,7 +116,7 @@ jobs:
|
||||
if: github.event.label.name == 'xxx'
|
||||
steps:
|
||||
- name: Create comment
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'create-comment'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -124,22 +125,21 @@ jobs:
|
||||
Hello ${{ github.event.issue.user.login }}. Add some comments.
|
||||
|
||||
你好 ${{ github.event.issue.user.login }}。巴拉巴拉。
|
||||
contents: '+1' or '+1,heart'
|
||||
emoji: '+1' or '+1,heart'
|
||||
```
|
||||
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| body | 新增评论的内容 | string | ✖ |
|
||||
| contents | 为新增评论的增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
|
||||
| emoji | 为新增评论的增加 [emoji](/guide/ref#-emoji-类型) | string | ✖ |
|
||||
|
||||
- `body` 默认为：`Currently at ${owner}/${repo}. And this is default comment.`
|
||||
- 其中 `${owner}/${repo}` 表示当前仓库
|
||||
- `body` 为空时，无操作
|
||||
- 返回 `comment-id`，可用于之后操作。[用法参考](/guide/ref#-outputs-使用)
|
||||
- `${{ github.event.issue.user.login }}` 表示该 issue 的创建者
|
||||
- `contents` 支持多个，需用逗号隔开
|
||||
- `emoji` 支持多个，需用逗号隔开
|
||||
|
||||
## `create-issue`
|
||||
|
||||
@@ -157,7 +157,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Create issue
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'create-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -165,19 +165,19 @@ jobs:
|
||||
body: 'xxxx'
|
||||
labels: 'xx'
|
||||
assignees: 'xxx'
|
||||
contents: '+1'
|
||||
emoji: '+1'
|
||||
```
|
||||
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| title | 新增 issue 的标题 | string | ✖ |
|
||||
| body | 新增 issue 的内容 | string | ✖ |
|
||||
| labels | 为新增 issue 添加 labels | string | ✖ |
|
||||
| assignees | 为新增 issue 添加 assignees | string | ✖ |
|
||||
| random-to | 当设置时，会在 assignees 中随机选择 | number | ✖ |
|
||||
| contents | 为新增 issue 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
|
||||
| emoji | 为新增 issue 增加 [emoji](/guide/ref#-emoji-类型) | string | ✖ |
|
||||
|
||||
- `title` 默认为：`Default Title`
|
||||
- 返回 `issue-number`，[用法参考](/guide/ref#-outputs-使用)
|
||||
@@ -188,7 +188,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Create label
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'create-label'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -200,7 +200,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| label-name | 标签名称，支持 emoji | string | ✔ |
|
||||
| label-color | 标签颜色，格式为 16 进制色码，不加 `#` | string | ✖ |
|
||||
| label-desc | 标签描述 | string | ✖ |
|
||||
@@ -214,7 +214,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Delete comment
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'delete-comment'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -224,11 +224,8 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| comment-id | 指定的 comment | number | ✔ |
|
||||
| out-comments | `find-comments` 的输出，若查找多个，则操作多个 | string | ✖ |
|
||||
|
||||
- 当 `out-comments` 输入时，`comment-id` 不起作用
|
||||
|
||||
## `lock-issue`
|
||||
|
||||
@@ -247,7 +244,7 @@ jobs:
|
||||
if: github.event.label.name == 'invalid'
|
||||
steps:
|
||||
- name: Lock issue
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'lock-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -257,68 +254,19 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| lock-reason | 锁定 issue 的原因 | string | ✖ |
|
||||
|
||||
- `lock-reason`：可选值有 `off-topic` `too heated` `resolved` `spam`
|
||||
|
||||
## `mark-duplicate`
|
||||
|
||||
快捷标记重复问题，仅作用于 issue 新增编辑评论。
|
||||
|
||||
```yml
|
||||
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@v2
|
||||
with:
|
||||
actions: 'mark-duplicate'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| duplicate-command | 可设置简洁命令，如：`/d` | string | ✖ |
|
||||
| duplicate-labels | 为该 issue 额外增加 labels | string | ✖ |
|
||||
| remove-labels | 设置可移除的 labels | string | ✖ |
|
||||
| labels | 替换该 issue 的 labels | string | ✖ |
|
||||
| contents | 为该评论的增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
|
||||
| close-issue | 是否同时关闭该 issue | string | ✖ |
|
||||
| require-permission | 要求权限，默认为 `write` | 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` 满足条件
|
||||
|
||||
<Alert>
|
||||
注意：使用简洁命令创建的 Duplicate 不显示下图红框内容。但其实这个没有任何影响的。
|
||||
</Alert>
|
||||
|
||||
|
||||
|
||||
## `open-issue`
|
||||
|
||||
打开指定 issue。
|
||||
|
||||
```yml
|
||||
- name: Open issue
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'open-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -328,7 +276,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
|
||||
## `remove-assignees`
|
||||
@@ -337,7 +285,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Remove assignees
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'remove-assignees'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -348,7 +296,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| assignees | 移除的指定人。当为空字符时，不进行移除 | string | ✔ |
|
||||
|
||||
@@ -358,7 +306,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Remove labels
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'remove-labels'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -369,7 +317,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| labels | 移除的 labels。当为空字符时，不进行移除 | string | ✔ |
|
||||
|
||||
@@ -381,7 +329,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Set labels
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'set-labels'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -392,7 +340,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| labels | labels 设置。当空字符时，会移除所有 | string | ✔ |
|
||||
|
||||
@@ -402,7 +350,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Unlock issue
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'unlock-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -412,7 +360,7 @@ jobs:
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
|
||||
## `update-comment`
|
||||
@@ -433,23 +381,23 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Update comment
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'update-comment'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
comment-id: ${{ github.event.comment.id }}
|
||||
contents: 'eyes'
|
||||
emoji: 'eyes'
|
||||
```
|
||||
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| comment-id | 指定的 comment | number | ✔ |
|
||||
| out-comments | `find-comments` 的输出，若查找多个，则操作多个 | string | ✖ |
|
||||
| body | 更新 comment 的内容 | string | ✖ |
|
||||
| update-mode | 更新模式。默认 `replace` 替换，`append` 附加 | string | ✖ |
|
||||
| contents | 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
|
||||
| emoji | 增加 [emoji](/guide/ref#-emoji-类型) | string | ✖ |
|
||||
|
||||
- `body` 不填时，会保持原有
|
||||
- `update-mode` 为 `append` 时，会进行附加操作。非 `append` 都会进行替换。仅对 `body` 生效
|
||||
@@ -461,7 +409,7 @@ jobs:
|
||||
|
||||
```yml
|
||||
- name: Update issue
|
||||
uses: actions-cool/issues-helper@v2
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'update-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -472,13 +420,13 @@ jobs:
|
||||
update-mode: 'replace'
|
||||
labels: 'xx'
|
||||
assignees: 'xxx'
|
||||
contents: '+1'
|
||||
emoji: '+1'
|
||||
```
|
||||
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✖ |
|
||||
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
|
||||
| state | 修改 issue 的状态，可选值 `open` `closed` | string | ✖ |
|
||||
| title | 修改 issue 的标题 | string | ✖ |
|
||||
@@ -486,45 +434,7 @@ jobs:
|
||||
| update-mode | 更新模式。默认 `replace` 替换，`append` 附加 | string | ✖ |
|
||||
| labels | 替换 issue 的 labels | string | ✖ |
|
||||
| assignees | 替换 issue 的 assignees | string | ✖ |
|
||||
| contents | 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
|
||||
| emoji | 增加 [emoji](/guide/ref#-emoji-类型) | string | ✖ |
|
||||
|
||||
- `state` 默认为 `open`
|
||||
- 当可选项不填时，会保持原有
|
||||
|
||||
|
||||
## `welcome`
|
||||
|
||||
当一个 issue 新建时，对首次新建 issue 的用户进行欢迎。若用户非首次新建，则无操作。
|
||||
|
||||
```yml
|
||||
name: Issue Welcome
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
|
||||
jobs:
|
||||
issue-welcome:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: welcome
|
||||
uses: actions-cool/issues-helper@v2
|
||||
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 | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| body | 评论欢迎的内容，不填则不评论 | string | ✖ |
|
||||
| labels | 为该 issue 增加 labels | string | ✖ |
|
||||
| assignees | 为该 issue 增加 assignees | string | ✖ |
|
||||
| issue-contents | 为该 issue 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
|
||||
|
||||
- 若这 4 个可选项都不填，则无操作
|
||||
Reference in New Issue
Block a user