actions-cool/issues-helper
1
0
Fork 0
mirror of https://gitea.com/Lydanne/issues-helper.git synced 2025-08-19 18:25:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update en (#7)

Browse Source 
* docs: update en

* add
This commit is contained in:
xrkffgg
2020-12-23 21:42:16 +08:00
committed by GitHub
parent 2fdb2ab06c
commit 418db9eda2
2 changed files with 228 additions and 230 deletions
Download Patch File Download Diff File Expand all files Collapse all files

417
README.md
View File

@@ -42,11 +42,11 @@ A GitHub Action to help you deal with issues
### ⭐ Base ### ⭐ Base
为了更好的展示功能，下面以实际场景举例，请灵活参考。 In order to better display the function, the following is an example of the actual scene, please refer to it flexibly.
#### `add-assignees` #### `add-assignees`
当一个 issue 新增或修改时，将这个 issue 指定某人或多人。 When an issue is added or modified, assign this issue to one or more people.
```yml ```yml
name: Add Assigness name: Add Assigness
@@ -68,23 +68,23 @@ jobs:
assignees: 'xxx' or ['xxx'] or ['xx1', 'xx2'] assignees: 'xxx' or ['xxx'] or ['xx1', 'xx2']
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| assignees | 指定人。当不填或者为空字符、空数组时，不指定 | string \| string\[] | ✖ | v1 | | assignees | Designated person. No operation when no input or empty character or empty array | string \| string\[] | ✖ | v1 |
- `actions` 支持多个，需用逗号隔开。如：`add-assignees,add-labels` - `actions` support multiple and separated by comma. Like: `add-assignees,add-labels`
- 其中的 `name` 可根据自行根据实际情况修改 - The `name` can be modified according to the actual situation
- [on 参考](#github-docs) - [on reference](#github-docs)
- `${{ github.event.issue.number }}` 表示当前 issue，[更多参考](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events) - `${{ github.event.issue.number }}` is the current issue. [More references](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events)
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `add-labels` #### `add-labels`
当一个新增的 issue 内容不包含指定格式时，为这个 issue 添加 labels。 When the content of a new issue does not contain the specified format, add labels for the issue.
```yml ```yml
name: Add Labels name: Add Labels
@@ -107,18 +107,18 @@ jobs:
labels: 'bug' or ['bug'] or ['bug1', 'bug2'] labels: 'bug' or ['bug'] or ['bug1', 'bug2']
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| labels | 新增的 labels。当不填或者为空字符、空数组时，不新增 | string \| string\[] | ✖ | v1 | | labels | New labels. When it is not filled in or is empty character, empty array, do not add | string \| string\[] | ✖ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `close-issue` #### `close-issue`
关闭指定 issue。 Close the specified issue.
```yml ```yml
- name: Close issue - name: Close issue
@@ -130,17 +130,17 @@ jobs:
body: 'This is auto closed.' body: 'This is auto closed.'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `create-comment` #### `create-comment`
当新增一个指定 label 时，对该 issue 进行评论。 When a designated label is added, comment on the issue.
```yml ```yml
name: Create Comment name: Create Comment
@@ -161,30 +161,30 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }} issue-number: ${{ github.event.issue.number }}
body: | body: |
Hello ${{ github.event.issue.user.login }}. Add some comments. Hello @${{ github.event.issue.user.login }}. Add some comments.
你好 ${{ github.event.issue.user.login }}。巴拉巴拉。 你好 @${{ github.event.issue.user.login }}。巴拉巴拉。
contents: '+1' or ['+1', 'heart'] contents: '+1' or ['+1', 'heart']
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| body | 新增评论的内容 | string | ✖ | v1 | | body | Add comment content | string | ✖ | v1 |
| contents | 为新增评论的增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 | | contents | Add [reaction](#reactions-types) | string \| string\[] | ✖ | v1 |
- `body` 默认为：`Currently at ${owner}/${repo}. And this is default comment.` - `body` default is `Currently at ${owner}/${repo}. And this is default comment.`
- 其中 `${owner}/${repo}` 表示当前仓库 - Where `${owner}/${repo}` means the current repo
- 返回 `comment-id`，可用于之后操作。[用法参考](#outputs-使用) - Return `comment-id`, which can be used for subsequent operations. [Usage reference](#outputs-use)
- `${{ github.event.issue.user.login }}` 表示该 issue 的创建者 - `${{ github.event.issue.user.login }}` indicates the creator of the issue
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `create-issue` #### `create-issue`
感觉新增 issue 使用场景不多。这里举例，每月 1 号 UTC 00:00 新增一个 issue。 Here is an example, add an issue at UTC 00:00 on the 1st of every month.
```yml ```yml
name: Create Issue name: Create Issue
@@ -209,25 +209,24 @@ jobs:
contents: '+1' contents: '+1'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| title | 新增 issue 的标题 | string | ✖ | v1 | | title | The title of the new issue | string | ✖ | v1 |
| body | 新增 issue 的内容 | string | ✖ | v1 | | body | The body of the new issue | string | ✖ | v1 |
| labels | 为新增 issue 添加 labels | string \| string\[] | ✖ | v1 | | labels | The labels for the new issue | string \| string\[] | ✖ | v1 |
| assignees | 为新增 issue 添加 assignees | string \| string\[] | ✖ | v1 | | assignees | The assignees for the new issue | string \| string\[] | ✖ | v1 |
| contents | 为新增 issue 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 | | contents | Add [reaction](#reactions-types) | string \| string\[] | ✖ | v1 |
- `title` 默认为：`Default Title` - `title` default is `Default Title`
- `body` 默认值同上 - Return `issue-number`. [Usage reference](#outputs-use)
- 返回 `issue-number`，[用法参考](#outputs-使用)
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `delete-comment` #### `delete-comment`
根据 [`comment-id`](#comment-id-获取) 删除指定评论。 According to [`comment-id`](#comment-id) delete the specified comment.
```yml ```yml
- name: Delete comment - name: Delete comment
@@ -238,17 +237,17 @@ jobs:
comment-id: xxx comment-id: xxx
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| comment-id | 指定的 comment | number | ✔ | v1 | | comment-id | The comment ID | number | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `lock-issue` #### `lock-issue`
当新增 `invalid` label 时，对该 issue 进行锁定。 When the `invalid` label is added, the issue is locked.
```yml ```yml
name: Lock Issue name: Lock Issue
@@ -270,17 +269,17 @@ jobs:
issue-number: ${{ github.event.issue.number }} issue-number: ${{ github.event.issue.number }}
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `open-issue` #### `open-issue`
打开指定 issue。 Open the specified issue.
```yml ```yml
- name: Open issue - name: Open issue
@@ -291,17 +290,17 @@ jobs:
issue-number: xxx issue-number: xxx
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `remove-assignees` #### `remove-assignees`
移除 issue 指定人员。 Remove the person designated by issue.
```yml ```yml
- name: Remove assignees - name: Remove assignees
@@ -313,18 +312,18 @@ jobs:
assignees: 'xx' assignees: 'xx'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| assignees | 移除的指定人。当为空字符、空数组时，不进行移除 | string \| string\[] | ✔ | v1 | | assignees | Designated person removed. When it is an empty character, empty array, do not remove | string \| string\[] | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `set-labels` #### `set-labels`
替换 issue 的 labels。 Replace the labels of issue.
```yml ```yml
- name: Set labels - name: Set labels
@@ -336,18 +335,18 @@ jobs:
labels: 'xx' labels: 'xx'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| labels | labels 设置。当空字符、空数组时，会移除所有 | string \| string\[] | ✔ | v1 | | labels | labels set. When empty characters, empty array, will remove all | string \| string\[] | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `unlock-issue` #### `unlock-issue`
解锁指定 issue。 Unlock the specified issue.
```yml ```yml
- name: Unlock issue - name: Unlock issue
@@ -358,19 +357,19 @@ jobs:
issue-number: ${{ github.event.issue.number }} issue-number: ${{ github.event.issue.number }}
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `update-comment` #### `update-comment`
根据 [`comment-id`](#comment-id-获取) 更新指定评论。 Update the specified comment according to [`comment-id`](#comment-id).
下面的例子展示的是，为每个新增的 comment 增加 👀 。 The following example shows that 👀 is added for each new comment.
```yml ```yml
name: Add eyes to each comment name: Add eyes to each comment
@@ -392,23 +391,23 @@ jobs:
contents: 'eyes' contents: 'eyes'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| comment-id | 指定的 comment | number | ✔ | v1 | | comment-id | The comment ID | number | ✔ | v1 |
| body | 更新 comment 的内容 | string | ✖ | v1 | | body | Update the content of comment | string | ✖ | v1 |
| update-mode | 更新模式。默认 `replace` 替换，`append` 附加， | string | ✖ | v1 | | update-mode | Update mode. Default `replace`, another `append` | string | ✖ | v1 |
| contents | 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 | | contents | Add [reaction](#reactions-types) | string \| string\[] | ✖ | v1 |
- `body` 不输入时，会保持原有 - When `body` is not entered, it will remain as it is
- `update-mode` 为 `append` 时，会进行附加操作。非 `append` 都会进行替换。仅对 `body` 生效 - When `update-mode` is `append`, additional operations will be performed. Anything other than `append` will be replaced. Only effective for `body`
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `update-issue` #### `update-issue`
根据 `issue-number` 更新指定 issue。 Update the specified issue according to the `issue-number`.
```yml ```yml
- name: Update issue - name: Update issue
@@ -426,31 +425,31 @@ jobs:
contents: '+1' contents: '+1'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| state | 修改 issue 的状态，可选值 `open` `closed` | string | ✖ | v1 | | state | Modify the status of issue, optional value `open` `closed` | string | ✖ | v1 |
| title | 修改 issue 的标题 | string | ✖ | v1 | | title | Modify the title of the issue | string | ✖ | v1 |
| body | 修改 issue 的内容 | string | ✖ | v1 | | body | Modify the content of issue | string | ✖ | v1 |
| update-mode | 更新模式。默认 `replace` 替换，`append` 附加 | string | ✖ | v1 | | update-mode | Update mode. Default `replace`, another `append` | string | ✖ | v1 |
| labels | 替换 issue 的 labels | string \| string\[] | ✖ | v1 | | labels | Replace the labels of issue | string \| string\[] | ✖ | v1 |
| assignees | 替换 issue 的 assignees | string \| string\[] | ✖ | v1 | | assignees | Replace the assignees of issue | string \| string\[] | ✖ | v1 |
| contents | 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 | | contents | Add [reaction](#reactions-types) | string \| string\[] | ✖ | v1 |
- `state` 默认为 `open` - `state` defaults to `open`
- 当可选项不填时，会保持原有 - When the option is not filled, it will keep the original
⏫ [返回列表](#List) ⏫ [Back to list](#List)
### ⭐ Advanced ### ⭐ Advanced
进阶用法不建议 actions 多重使用。 It is not recommended to use multiple actions for advanced usage.
#### `check-inactive` #### `check-inactive`
每月 1 号 UTC 0 时，对所有 30 天以上未活跃的 issues 增加 `inactive` 标签。 At UTC 0 on the 1st of each month, add the `inactive` tag to all issues that have not been active for more than 30 days.
```yml ```yml
name: Check inactive name: Check inactive
@@ -471,30 +470,30 @@ jobs:
inactive-day: 30 inactive-day: 30
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| body | 操作 issue 时，可进行评论。不输入时，不评论 | string | ✖ | v1 | | body | When operating an issue, you can comment. Do not comment when not typing | string | ✖ | v1 |
| labels | 标签筛选 | string \| string\[] | ✖ | v1 | | labels | Labels filtering | string \| string\[] | ✖ | v1 |
| issue-state | 状态筛选 | string | ✖ | v1 | | issue-state | State filtering | string | ✖ | v1 |
| issue-assignee | 指定人筛选 | string | ✖ | v1 | | issue-assignee | Assignee filtering | string | ✖ | v1 |
| issue-creator | 创建人筛选 | string | ✖ | v1 | | issue-creator | Creator filtering | string | ✖ | v1 |
| issue-mentioned | 提及人筛选 | string | ✖ | v1 | | issue-mentioned | Mentioned filtering | string | ✖ | v1 |
| body-includes | 包含内容筛选 | string | ✖ | v1 | | body-includes | Body filtering | string | ✖ | v1 |
| title-includes | 包含标题筛选 | string | ✖ | v1 | | title-includes | Title filtering | string | ✖ | v1 |
| inactive-day | 非活跃天数筛选 | number | ✖ | v1 | | inactive-day | Inactive days filtering | number | ✖ | v1 |
| inactive-label | 新增标签名称 | string | ✖ | v1 | | inactive-label | The label name adding | string | ✖ | v1 |
- `labels`：为多个时，会查询同时拥有多个。不输入时，会查询所有 - `labels`: When there are multiple, the query will have multiple at the same time. If not entered, all
- `issue-state`：默认为 `all`。可选值 `open` `closed`，非这 2 项时，均为 `all` - `issue-state`: The default is `all`. Optional value `open` `closed`, when these 2 items are not, both are `all`
- `issue-assignee`：不支持多人。不输入或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues - `issue-assignee`: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering `none` will query issues for which the specified person is not added
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不输入时，会查询所有 - `inactive-day`: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
- `inactive-label`：默认为 `inactive`，可自定义其他。当项目未包含该 label 时，会自动新建 - `inactive-label`: The default is `inactive`, others can be customized. When the project does not contain the label, it will be created automatically
#### `close-issues` #### `close-issues`
每 7 天 UTC 0 时，关闭已填加 `need info` label 且 7 天以上未活跃的 issues。 Every 7 days at UTC 0, close the issues that have been filled with the `need info` label and have not been active for more than 7 days.
```yml ```yml
name: Check need info name: Check need info
@@ -516,28 +515,28 @@ jobs:
inactive-day: 7 inactive-day: 7
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| body | 操作 issue 时，可进行评论。不输入时，不评论 | string | ✖ | v1 | | body | When operating an issue, you can comment. Do not comment when not typing | string | ✖ | v1 |
| labels | 标签筛选 | string \| string\[] | ✖ | v1 | | labels | Labels filtering | string \| string\[] | ✖ | v1 |
| issue-assignee | 指定人筛选 | string | ✖ | v1 | | issue-assignee | Assignee filtering | string | ✖ | v1 |
| issue-creator | 创建人筛选 | string | ✖ | v1 | | issue-creator | Creator filtering | string | ✖ | v1 |
| issue-mentioned | 提及人筛选 | string | ✖ | v1 | | issue-mentioned | Mentioned filtering | string | ✖ | v1 |
| body-includes | 包含内容筛选 | string | ✖ | v1 | | body-includes | Body filtering | string | ✖ | v1 |
| title-includes | 包含标题筛选 | string | ✖ | v1 | | title-includes | Title filtering | string | ✖ | v1 |
| inactive-day | 非活跃天数筛选 | number | ✖ | v1 | | inactive-day | Inactive days filtering | number | ✖ | v1 |
- `labels`：为多个时，会查询同时拥有多个。不输入时，会查询所有 - `labels`: When there are multiple, the query will have multiple at the same time. If not entered, all
- `issue-assignee`：不支持多人。不输入或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues - `issue-assignee`: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering `none` will query issues for which the specified person is not added
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不输入时，会查询所有 - `inactive-day`: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `find-comments` #### `find-comments`
查找当前仓库 1 号 issue 中，创建者是 k ，内容包含 `this` 的评论列表。 Find the current warehouse issue No. 1, the creator is k and the content contains the comment list of `this`.
```yml ```yml
- name: Find comments - name: Find comments
@@ -550,16 +549,16 @@ jobs:
body-includes: 'this' body-includes: 'this'
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | The number of issue | number | ✔ | v1 |
| comment-auth | 评论创建者，不填时会查询所有 | string | ✖ | v1 | | comment-auth | Comment creator, all will be queried if not filled | string | ✖ | v1 |
| body-includes | 评论内容包含过滤，不填时无校验 | string | ✖ | v1 | | body-includes | Comment content includes filtering, no verification if not filled | string | ✖ | v1 |
| direction | 返回 `comments` 排序 | string | ✖ | v1 | | direction | Return `comments` sort | string | ✖ | v1 |
- 返回 `comments`，格式如下： - Return `comments` in the following format:
```js ```js
[ [
@@ -568,14 +567,14 @@ jobs:
] ]
``` ```
- `direction` 默认为升序，只有设置 `desc` 时，会返回降序 - `direction` defaults to ascending order, only when `desc` is set, descending order will be returned
- 返回数组中 `created` `updated`，由所处环境决定，会是 UTC +0 - The `created` `updated` in the returned array, determined by the environment, will be UTC +0
⏫ [返回列表](#List) ⏫ [Back to list](#List)
#### `lock-issues` #### `lock-issues`
每 3 个月 1 号 UTC 0 时，锁定已填加 `inactive` label 且 128 天以上未活跃的所有 issues。 Every 3 months at UTC 0 on the 1st, lock all issues that have been filled with the `inactive` label and have not been active for more than 128 days.
```yml ```yml
name: Lock inactive issues name: Lock inactive issues
@@ -597,34 +596,34 @@ jobs:
inactive-day: 128 inactive-day: 128
``` ```
| 参数 | 描述 | 类型 | 必填 | 版本 | | Param | Desc | Type | Required | Version |
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | Action type | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [Token explain](#token) | string | ✔ | v1 |
| body | 操作 issue 时，可进行评论。不输入时，不评论 | string | ✖ | v1 | | body | When operating an issue, you can comment. Do not comment when not typing | string | ✖ | v1 |
| labels | 标签筛选 | string \| string\[] | ✖ | v1 | | labels | Labels filtering | string \| string\[] | ✖ | v1 |
| issue-state | 状态筛选 | string | ✖ | v1 | | issue-state | State filtering | string | ✖ | v1 |
| issue-assignee | 指定人筛选 | string | ✖ | v1 | | issue-assignee | Assignee filtering | string | ✖ | v1 |
| issue-creator | 创建人筛选 | string | ✖ | v1 | | issue-creator | Creator filtering | string | ✖ | v1 |
| issue-mentioned | 提及人筛选 | string | ✖ | v1 | | issue-mentioned | Mentioned filtering | string | ✖ | v1 |
| body-includes | 包含内容筛选 | string | ✖ | v1 | | body-includes | Body filtering | string | ✖ | v1 |
| title-includes | 包含标题筛选 | string | ✖ | v1 | | title-includes | Title filtering | string | ✖ | v1 |
| inactive-day | 非活跃天数筛选 | number | ✖ | v1 | | inactive-day | Inactive days filtering | number | ✖ | v1 |
- `labels`：为多个时，会查询同时拥有多个。不输入时，会查询所有 - `labels`: When there are multiple, the query will have multiple at the same time. If not entered, all
- `issue-state`：默认为 `all`。可选值 `open` `closed`，非这 2 项时，均为 `all` - `issue-state`: The default is `all`. Optional value `open` `closed`, when these 2 items are not, both are `all`
- `issue-assignee`：不支持多人。不输入或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues - `issue-assignee`: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering `none` will query issues for which the specified person is not added
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不输入时，会查询所有 - `inactive-day`: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
⏫ [返回列表](#List) ⏫ [Back to list](#List)
## 🌰 例 子 ## 🌰 Example
灵活参考。 Flexible reference.
### `find-comments + create-comment + update-comment` ### `find-comments + create-comment + update-comment`
假设场景：当添加了 `watch` label 的 issue 修改时，查找是否有 k 创建的包含 `error` 的评论，如果只有一个，则更新该 comment，如果没有，则新增一个 comment。 Hypothetical scenario: When the issue modification of the `watch` label is added, find out whether there is a comment containing `error` created by k, if there is only one, update the comment, if not, add a new comment.
```yml ```yml
name: Test name: Test
@@ -668,26 +667,26 @@ jobs:
update-mode: 'append' update-mode: 'append'
``` ```
⏫ [返回列表](#List) ⏫ [Back to list](#List)
## 🎁 参 考 ## 🎁 Reference
### token ### token
需拥有 push 权限的人员 token。 Need to have the person token with push permission.
- [个人 token 申请](https://github.com/settings/tokens) - [Personal token application](https://github.com/settings/tokens)
- 需勾选 `Full control of private repositories` - Need to check `Full control of private repositories`
- 项目添加 secrets - Project add secrets
- 选择 settings，选择 secrets，选择 `New repository secret` - Select settings, select secrets, select `New repository secret`
- `Name` 与 actions 中保持一致 - `Name` is the same as in actions
- `Value` 填写刚才个人申请的 token - `Value` fill in the token just applied by the individual
当 actions 不填写 token 时，会默认为 github-actions <kbd>bot</kbd>。 When the token is not filled in actions or the corresponding secrets are not added to the project, it will default to github-actions <kbd>bot</kbd>.
⏫ [返回列表](#List) ⏫ [Back to list](#List)
### `outputs` 使用 ### `outputs` use
```yml ```yml
- name: Create issue - name: Create issue
@@ -702,10 +701,10 @@ jobs:
### GitHub Docs ### GitHub Docs
- [GitHub Actions 语法](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
- [工作流触发机制](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows) - [Events that trigger workflows](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
⏫ [返回列表](#List) ⏫ [Back to list](#List)
### Reactions types ### Reactions types
@@ -720,21 +719,21 @@ jobs:
| `rocket` | 🚀 | | `rocket` | 🚀 |
| `eyes` | 👀 | | `eyes` | 👀 |
⏫ [返回列表](#List) ⏫ [Back to list](#List)
### `comment-id` 获取 ### `comment-id`
点击某个评论右上角 `···` 图标，选择 `Copy link`，url 末尾数字即是 `comment_id`。 Click the `···` icon in the upper right corner of a comment, select `Copy link`, and the number at the end of the url is `comment_id`.
⏫ [返回列表](#List) ⏫ [Back to list](#List)
## Actions 模板 ## Actions Template
[GitHub Actions workflow template](https://github.com/actions-cool/.github) Fork 后，可直接使用模板。 [GitHub Actions workflow template](https://github.com/actions-cool/.github). After fork, you can use the template directly.
## 💖 谁在使用？ ## 💖 Who are using?
欢迎在[ **这里** ](https://github.com/actions-cool/issue-helper/issues/6)留言。 You can come to the following reference template. Please leave a message at [**here** ](https://github.com/actions-cool/issue-helper/issues/6).
## LICENSE ## LICENSE

41
README.zh-CN.md
View File

@@ -73,7 +73,7 @@ jobs:
| actions | 操作类型 | string | ✔ | v1 | | actions | 操作类型 | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [token 说明](#token) | string | ✔ | v1 |
| issue-number | 指定的 issue | number | ✔ | v1 | | issue-number | 指定的 issue | number | ✔ | v1 |
| assignees | 指定人。当不填或者为空字符、空数组时，不指定 | string \| string\[] | ✖ | v1 | | assignees | 指定人。当不填或者为空字符、空数组时，不操作 | string \| string\[] | ✖ | v1 |
- `actions` 支持多个，需用逗号隔开。如：`add-assignees,add-labels` - `actions` 支持多个，需用逗号隔开。如：`add-assignees,add-labels`
- 其中的 `name` 可根据自行根据实际情况修改 - 其中的 `name` 可根据自行根据实际情况修改
@@ -220,14 +220,13 @@ jobs:
| contents | 为新增 issue 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 | | contents | 为新增 issue 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 |
- `title` 默认为：`Default Title` - `title` 默认为：`Default Title`
- `body` 默认值同上
- 返回 `issue-number`，[用法参考](#outputs-使用) - 返回 `issue-number`，[用法参考](#outputs-使用)
⏫ [返回列表](#列-表) ⏫ [返回列表](#列-表)
#### `delete-comment` #### `delete-comment`
根据 [`comment-id`](#comment-id-获取) 删除指定评论。 根据 [`comment-id`](#comment-id) 删除指定评论。
```yml ```yml
- name: Delete comment - name: Delete comment
@@ -368,7 +367,7 @@ jobs:
#### `update-comment` #### `update-comment`
根据 [`comment-id`](#comment-id-获取) 更新指定评论。 根据 [`comment-id`](#comment-id) 更新指定评论。
下面的例子展示的是，为每个新增的 comment 增加 👀 。 下面的例子展示的是，为每个新增的 comment 增加 👀 。
@@ -398,10 +397,10 @@ jobs:
| token | [token 说明](#token) | string | ✔ | v1 | | token | [token 说明](#token) | string | ✔ | v1 |
| comment-id | 指定的 comment | number | ✔ | v1 | | comment-id | 指定的 comment | number | ✔ | v1 |
| body | 更新 comment 的内容 | string | ✖ | v1 | | body | 更新 comment 的内容 | string | ✖ | v1 |
| update-mode | 更新模式。默认 `replace` 替换，`append` 附加， | string | ✖ | v1 | | update-mode | 更新模式。默认 `replace` 替换，`append` 附加 | string | ✖ | v1 |
| contents | 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 | | contents | 增加 [reaction](#reactions-types) | string \| string\[] | ✖ | v1 |
- `body` 不输入时，会保持原有 - `body` 不填时，会保持原有
- `update-mode` 为 `append` 时，会进行附加操作。非 `append` 都会进行替换。仅对 `body` 生效 - `update-mode` 为 `append` 时，会进行附加操作。非 `append` 都会进行替换。仅对 `body` 生效
⏫ [返回列表](#列-表) ⏫ [返回列表](#列-表)
@@ -475,7 +474,7 @@ jobs:
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | 操作类型 | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [token 说明](#token) | string | ✔ | v1 |
| body | 操作 issue 时，可进行评论。不输入时，不评论 | string | ✖ | v1 | | body | 操作 issue 时，可进行评论。不填时，不评论 | string | ✖ | v1 |
| labels | 标签筛选 | string \| string\[] | ✖ | v1 | | labels | 标签筛选 | string \| string\[] | ✖ | v1 |
| issue-state | 状态筛选 | string | ✖ | v1 | | issue-state | 状态筛选 | string | ✖ | v1 |
| issue-assignee | 指定人筛选 | string | ✖ | v1 | | issue-assignee | 指定人筛选 | string | ✖ | v1 |
@@ -486,10 +485,10 @@ jobs:
| inactive-day | 非活跃天数筛选 | number | ✖ | v1 | | inactive-day | 非活跃天数筛选 | number | ✖ | v1 |
| inactive-label | 新增标签名称 | string | ✖ | v1 | | inactive-label | 新增标签名称 | string | ✖ | v1 |
- `labels`：为多个时，会查询同时拥有多个。不输入时，会查询所有 - `labels`：为多个时，会查询同时拥有多个。不填时，会查询所有
- `issue-state`：默认为 `all`。可选值 `open` `closed`，非这 2 项时，均为 `all` - `issue-state`：默认为 `all`。可选值 `open` `closed`，非这 2 项时，均为 `all`
- `issue-assignee`：不支持多人。不输入或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues - `issue-assignee`：不支持多人。不填或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不输入时，会查询所有 - `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
- `inactive-label`：默认为 `inactive`，可自定义其他。当项目未包含该 label 时，会自动新建 - `inactive-label`：默认为 `inactive`，可自定义其他。当项目未包含该 label 时，会自动新建
#### `close-issues` #### `close-issues`
@@ -520,7 +519,7 @@ jobs:
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | 操作类型 | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [token 说明](#token) | string | ✔ | v1 |
| body | 操作 issue 时，可进行评论。不输入时，不评论 | string | ✖ | v1 | | body | 操作 issue 时，可进行评论。不填时，不评论 | string | ✖ | v1 |
| labels | 标签筛选 | string \| string\[] | ✖ | v1 | | labels | 标签筛选 | string \| string\[] | ✖ | v1 |
| issue-assignee | 指定人筛选 | string | ✖ | v1 | | issue-assignee | 指定人筛选 | string | ✖ | v1 |
| issue-creator | 创建人筛选 | string | ✖ | v1 | | issue-creator | 创建人筛选 | string | ✖ | v1 |
@@ -529,9 +528,9 @@ jobs:
| title-includes | 包含标题筛选 | string | ✖ | v1 | | title-includes | 包含标题筛选 | string | ✖ | v1 |
| inactive-day | 非活跃天数筛选 | number | ✖ | v1 | | inactive-day | 非活跃天数筛选 | number | ✖ | v1 |
- `labels`：为多个时，会查询同时拥有多个。不输入时，会查询所有 - `labels`：为多个时，会查询同时拥有多个。不填时，会查询所有
- `issue-assignee`：不支持多人。不输入或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues - `issue-assignee`：不支持多人。不填或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不输入时，会查询所有 - `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
⏫ [返回列表](#列-表) ⏫ [返回列表](#列-表)
@@ -601,7 +600,7 @@ jobs:
| -- | -- | -- | -- | -- | | -- | -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ | v1 | | actions | 操作类型 | string | ✔ | v1 |
| token | [token 说明](#token) | string | ✔ | v1 | | token | [token 说明](#token) | string | ✔ | v1 |
| body | 操作 issue 时，可进行评论。不输入时，不评论 | string | ✖ | v1 | | body | 操作 issue 时，可进行评论。不填时，不评论 | string | ✖ | v1 |
| labels | 标签筛选 | string \| string\[] | ✖ | v1 | | labels | 标签筛选 | string \| string\[] | ✖ | v1 |
| issue-state | 状态筛选 | string | ✖ | v1 | | issue-state | 状态筛选 | string | ✖ | v1 |
| issue-assignee | 指定人筛选 | string | ✖ | v1 | | issue-assignee | 指定人筛选 | string | ✖ | v1 |
@@ -611,10 +610,10 @@ jobs:
| title-includes | 包含标题筛选 | string | ✖ | v1 | | title-includes | 包含标题筛选 | string | ✖ | v1 |
| inactive-day | 非活跃天数筛选 | number | ✖ | v1 | | inactive-day | 非活跃天数筛选 | number | ✖ | v1 |
- `labels`：为多个时，会查询同时拥有多个。不输入时，会查询所有 - `labels`：为多个时，会查询同时拥有多个。不填时，会查询所有
- `issue-state`：默认为 `all`。可选值 `open` `closed`，非这 2 项时，均为 `all` - `issue-state`：默认为 `all`。可选值 `open` `closed`，非这 2 项时，均为 `all`
- `issue-assignee`：不支持多人。不输入或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues - `issue-assignee`：不支持多人。不填或输入 * 时，查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不输入时，会查询所有 - `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
⏫ [返回列表](#列-表) ⏫ [返回列表](#列-表)
@@ -683,7 +682,7 @@ jobs:
- `Name` 与 actions 中保持一致 - `Name` 与 actions 中保持一致
- `Value` 填写刚才个人申请的 token - `Value` 填写刚才个人申请的 token
当 actions 不填写 token 时，会默认为 github-actions <kbd>bot</kbd>。 当 actions 不填写 token 时，或项目未添加对应 secrets 时，会默认为 github-actions <kbd>bot</kbd>。
⏫ [返回列表](#列-表) ⏫ [返回列表](#列-表)
@@ -722,7 +721,7 @@ jobs:
⏫ [返回列表](#列-表) ⏫ [返回列表](#列-表)
### `comment-id` 获取 ### `comment-id`
点击某个评论右上角 `···` 图标，选择 `Copy link`，url 末尾数字即是 `comment_id`。 点击某个评论右上角 `···` 图标，选择 `Copy link`，url 末尾数字即是 `comment_id`。
@@ -734,7 +733,7 @@ jobs:
## 💖 谁在使用？ ## 💖 谁在使用？
欢迎在[ **这里** ](https://github.com/actions-cool/issue-helper/issues/6)留言。 你可以来以下项目参考模版。欢迎在[ **这里** ](https://github.com/actions-cool/issue-helper/issues/6)留言。
## LICENSE ## LICENSE