mirror of
https://gitea.com/Lydanne/issues-helper.git
synced 2025-08-19 18:25:58 +08:00
style: update style & changelog
This commit is contained in:
68
README.md
68
README.md
@@ -255,8 +255,8 @@ When the following list does not have the features you want, you can submit it i
|
||||
- [`lock-issues`](#lock-issues)
|
||||
- [`mark-assignees`](#mark-assignees)
|
||||
- [`mark-duplicate`](#mark-duplicate)
|
||||
- [`welcome`](#welcome)
|
||||
- [`toggle-labels`](#toggle-labels)
|
||||
- [`welcome`](#welcome)
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
@@ -1110,6 +1110,39 @@ jobs:
|
||||
|
||||
⏫ [Back to list](#List)
|
||||
|
||||
#### `toggle-labels`
|
||||
|
||||
When an issue is reopened, the set labels are removed if they already exist, otherwise they are added.
|
||||
|
||||
```yml
|
||||
name: Toggle Labels
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [reopened]
|
||||
|
||||
jobs:
|
||||
toggle-labels:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Toggle labels
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'toggle-labels'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
labels: 'unread,outdated'
|
||||
```
|
||||
|
||||
| Param | Desc | Type | Required |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | Action type | string | ✔ |
|
||||
| token | [Token explain](#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 | ✖ |
|
||||
|
||||
⏫ [Back to list](#List)
|
||||
|
||||
#### `welcome`
|
||||
|
||||
When an issue is created, the user who created the issue for the first time is welcome.
|
||||
@@ -1151,39 +1184,6 @@ jobs:
|
||||
|
||||
⏫ [Back to list](#List)
|
||||
|
||||
#### `toggle-labels`
|
||||
|
||||
When an issue is reopened, the set labels are removed if they already exist, otherwise they are added.
|
||||
|
||||
```yml
|
||||
name: Toggle Labels
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [reopened]
|
||||
|
||||
jobs:
|
||||
toggle-labels:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Toggle labels
|
||||
uses: actions-cool/issues-helper@v3
|
||||
with:
|
||||
actions: 'toggle-labels'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
labels: 'unread,outdated'
|
||||
```
|
||||
|
||||
| Param | Desc | Type | Required |
|
||||
| -- | -- | -- | -- |
|
||||
| actions | Action type | string | ✔ |
|
||||
| token | [Token explain](#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 | ✖ |
|
||||
|
||||
⏫ [Back to list](#List)
|
||||
|
||||
## 🎁 Reference
|
||||
|
||||
### token
|
||||
|
Reference in New Issue
Block a user