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

chore: improved docs (#152)

Browse Source 
* chore: improved docs

* chore: format code

* deps: upgrade dumi 2.1.21

fix https://github.com/actions-cool/issues-helper/issues/153

* chore: update style

* docs: update docs
This commit is contained in:
Wuxh
2023-04-17 19:09:03 +08:00
committed by GitHub
parent 5586509e90
commit 36a1dd8767
12 changed files with 197 additions and 1979 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.zh-CN.md
View File

@@ -266,6 +266,8 @@
### ⭐ 基 础
<wrapper base data-depth="2" data-warn="DO_NOT_REMOVE_THIS_COMMENT">
为了更好的展示功能，下面以实际场景举例，请灵活参考。
#### `add-assignees`
@@ -308,7 +310,7 @@ jobs:
- `assignees` 支持多个，需用逗号隔开
- assign 最多只能设定 10 个
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `add-labels`
@@ -344,7 +346,7 @@ jobs:
- `labels` 支持多个，需用逗号隔开
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `close-issue`
@@ -366,7 +368,7 @@ jobs:
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
| close-reason | 关闭原因。默认`not_planned`未计划，`completed`完成 | string | ✖ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `create-comment`
@@ -410,7 +412,7 @@ jobs:
- `${{ github.event.issue.user.login }}` 表示该 issue 的创建者
- `emoji` 支持多个，需用逗号隔开
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `create-issue`
@@ -453,7 +455,7 @@ jobs:
- `title` 为空时，无操作
- 返回 `issue-number`，[用法参考](#outputs-使用)
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `create-label`
@@ -481,7 +483,7 @@ jobs:
- `label-name`：若已存在，则无操作
- `label-color`：默认为 `ededed`
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `delete-comment`
@@ -502,7 +504,7 @@ jobs:
| token | [token 说明](#token) | string | ✖ |
| comment-id | 指定的 comment | number | ✔ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `get-issue`
@@ -523,7 +525,7 @@ jobs:
- 返回 `issue-number` `issue-title` `issue-body` `issue-labels` `issue-assignees` `issue-state`，[用法参考](#outputs-使用)
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `lock-issue`
@@ -558,7 +560,7 @@ jobs:
- `lock-reason`：可选值有 `off-topic` `too heated` `resolved` `spam`
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `open-issue`
@@ -579,7 +581,7 @@ jobs:
| token | [token 说明](#token) | string | ✖ |
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `remove-assignees`
@@ -602,7 +604,7 @@ jobs:
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
| assignees | 移除的指定人。当为空字符时，不进行移除 | string | ✔ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `remove-labels`
@@ -627,7 +629,7 @@ jobs:
- `labels` 支持多个，如 `x1,x2,x3`，只会移除 issue 已添加的 labels
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `set-labels`
@@ -650,7 +652,7 @@ jobs:
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
| labels | labels 设置。当空字符时，会移除所有 | string | ✔ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `unlock-issue`
@@ -671,7 +673,7 @@ jobs:
| token | [token 说明](#token) | string | ✖ |
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `update-comment`
@@ -711,7 +713,7 @@ jobs:
- `body` 不填时，会保持原有
- `update-mode` 为 `append` 时，会进行附加操作。非 `append` 都会进行替换。仅对 `body` 生效
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `update-issue`
@@ -749,9 +751,11 @@ jobs:
- `state` 默认为 `open`
- 当可选项不填时，会保持原有
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
</wrapper>
### 🌟 进 阶
<wrapper advanced data-depth="2" data-warn="DO_NOT_REMOVE_THIS_COMMENT">
进阶用法不建议 actions 多个一次同时使用。
@@ -802,7 +806,7 @@ jobs:
- `inactive-label`：默认为 `inactive`，可自定义其他。当项目未包含该 label 时，会自动新建
- `exclude-labels`：设置包含 `$exclude-empty` 时，可排除无 label issue
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `check-issue`
@@ -844,7 +848,7 @@ jobs:
- `title-includes` `body-includes` 支持格式 `x1,x2` 或者 `x1,x2/y1,y2`。只支持两个层级
- 返回 `check-result`，由于 yml 原因，判断条件为 `if: steps.xxid.outputs.check-result == 'true'`
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `close-issues`
@@ -891,7 +895,7 @@ jobs:
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
- `exclude-labels`：设置包含 `$exclude-empty` 时，可排除无 label issue
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `find-comments`
@@ -929,7 +933,7 @@ jobs:
- `direction` 默认为升序，只有设置 `desc` 时，会返回降序
- 返回数组中 `created` `updated`，由所处环境决定，会是 UTC +0
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `find-issues`
@@ -974,7 +978,7 @@ jobs:
- 返回数组中 `created` `updated`，由所处环境决定，会是 UTC +0
- `exclude-labels`：设置包含 `$exclude-empty` 时，可排除无 label issue
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `lock-issues`
@@ -1023,7 +1027,7 @@ jobs:
- `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
- `exclude-labels`：设置包含 `$exclude-empty` 时，可排除无 label issue
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `mark-assignees`
@@ -1061,7 +1065,7 @@ jobs:
- 普通用户为 `read` 权限
- 当设置 `write` 后，`admin` 和 `write` 满足条件
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `mark-duplicate`
@@ -1107,7 +1111,7 @@ jobs:
- 普通用户为 `read` 权限
- 当设置 `write` 后，`admin` 和 `write` 满足条件
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `toggle-labels`
@@ -1140,7 +1144,7 @@ jobs:
| issue-number | 指定的 issue，当不传时会从触发事件中获取 | number | ✖ |
| labels | 切换 labels。如果 label 已存在则删除，不存在则添加 | string | ✖ |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
#### `welcome`
@@ -1180,9 +1184,11 @@ jobs:
- 若这 4 个可选项都不填，则无操作
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
</wrapper>
## 🎁 参 考
<wrapper reference data-depth="1" data-warn="DO_NOT_REMOVE_THIS_COMMENT">
### token
@@ -1197,14 +1203,14 @@ jobs:
当 actions 不填写 token 时，或填写 `${{ secrets.GITHUB_TOKEN }}`，会默认为 `github-actions-bot`。[更多查看](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)。
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
### GitHub Docs
- [GitHub Actions 语法](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)
- [工作流触发机制](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
### `outputs` 使用
@@ -1224,7 +1230,7 @@ jobs:
1. https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/metadata-syntax-for-github-actions#outputs
2. https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idoutputs
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
### 校验规则
@@ -1254,7 +1260,7 @@ x2 + y2
"x1" false
```
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
### emoji 类型
@@ -1269,13 +1275,14 @@ x2 + y2
| `rocket` | 🚀 |
| `eyes` | 👀 |
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
### `comment-id`
点击某个评论右上角 `···` 图标，选择 `Copy link`，url 末尾数字即是 `comment_id`。
⏫ [返回列表](#列-表)
[⏫ 返回列表](#列-表)
</wrapper>
## Actions 模板