docs: update docs

This commit is contained in:
wuxh
2023-01-12 22:46:36 +08:00
parent 8f847c01c2
commit b08e8f300e
4 changed files with 90 additions and 0 deletions

View File

@@ -458,3 +458,24 @@ Update the specified issue according to the `issue-number`.
- `state` defaults to `open`
- When the option is not filled, it will keep the original
## `toggle-labels`
Toggle the labels of issue.
```yml
- name: Toggle labels
uses: actions-cool/issues-helper@v3
with:
actions: 'toggle-labels'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }}
labels: 'xx'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | ✖ |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| labels | The toggle labels. Delete if the label already exists, add if it does not exist | string | ✔ |

View File

@@ -458,3 +458,24 @@ jobs:
- `state` 默认为 `open`
- 当可选项不填时,会保持原有
## `toggle-labels`
切换 issue 的 labels。
```yml
- name: Toggle labels
uses: actions-cool/issues-helper@v3
with:
actions: 'toggle-labels'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }}
labels: 'xx'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| labels | 切换 labels。如果 label 已存在则删除,不存在则添加 | string | ✔ |