mirror of
https://gitea.com/Lydanne/issues-helper.git
synced 2025-08-20 02:35:58 +08:00
add doc
This commit is contained in:
@@ -183,6 +183,32 @@ jobs:
|
||||
- `title` default is `Default Title`
|
||||
- Return `issue-number`. [Usage reference](/en-US/guide/ref#-outputs-use)
|
||||
|
||||
## `create-label`
|
||||
|
||||
Create label。If you want to create multiple labels base on repository path. [See](https://github.com/actions-cool/create-labels).
|
||||
|
||||
```yml
|
||||
- name: Create label
|
||||
uses: actions-cool/issues-helper@v2.0.0
|
||||
with:
|
||||
actions: 'create-label'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
label-name: 'xx'
|
||||
label-color: '0095b3'
|
||||
label-desc: 'xx'
|
||||
```
|
||||
|
||||
| Param | Desc | Type | Required |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | Action type | string | ✔ |
|
||||
| token | [Token explain](/en-US/guide/ref#-token) | string | ✔ |
|
||||
| label-name | Label name, emoji support | string | ✔ |
|
||||
| label-color | Label color, the format is hexadecimal color code, without `#` | string | ✖ |
|
||||
| label-desc | Label description | string | ✖ |
|
||||
|
||||
- `label-name`: If it already exists, no operation
|
||||
- `label-color`: Default is `ededed`
|
||||
|
||||
## `delete-comment`
|
||||
|
||||
According to [`comment-id`](/en-US/guide/ref#-comment-id) delete the specified comment.
|
||||
|
26
docs/base.md
26
docs/base.md
@@ -183,6 +183,32 @@ jobs:
|
||||
- `title` 默认为:`Default Title`
|
||||
- 返回 `issue-number`,[用法参考](/guide/ref#-outputs-使用)
|
||||
|
||||
## `create-label`
|
||||
|
||||
新增 label。若想根据目录生成多个 labels,[可查看](https://github.com/actions-cool/create-labels)。
|
||||
|
||||
```yml
|
||||
- name: Create label
|
||||
uses: actions-cool/issues-helper@v2.0.0
|
||||
with:
|
||||
actions: 'create-label'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
label-name: 'xx'
|
||||
label-color: '0095b3'
|
||||
label-desc: 'xx'
|
||||
```
|
||||
|
||||
| 参数 | 描述 | 类型 | 必填 |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | 操作类型 | string | ✔ |
|
||||
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
|
||||
| label-name | 标签名称,支持 emoji | string | ✔ |
|
||||
| label-color | 标签颜色,格式为 16 进制色码,不加 `#` | string | ✖ |
|
||||
| label-desc | 标签描述 | string | ✖ |
|
||||
|
||||
- `label-name`:若已存在,则无操作
|
||||
- `label-color`:默认为 `ededed`
|
||||
|
||||
## `delete-comment`
|
||||
|
||||
根据 [`comment-id`](/guide/ref#-comment-id) 删除指定评论。
|
||||
|
Reference in New Issue
Block a user