Skip to content

Commit 400a6ee

Browse files
committed
update README
1 parent 35f1582 commit 400a6ee

2 files changed

Lines changed: 15 additions & 16 deletions

File tree

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ ___
2525

2626
### YAML configuration
2727

28-
In the repository where you want to perform this action, create the YAML file `.github/labels.yml` (you can also set a [custom filename](#customizing)) that looks like:
28+
In the repository where you want to perform this action, create the YAML file
29+
`.github/labels.yml` (you can also set a [custom filename](#customizing)) that
30+
looks like:
2931

3032
```yaml
3133
- name: "bug"
@@ -71,19 +73,17 @@ jobs:
7173
uses: actions/checkout@v3
7274
-
7375
name: Run Labeler
74-
if: success()
7576
uses: crazy-max/ghaction-github-labeler@v4
7677
with:
7778
github-token: ${{ secrets.GITHUB_TOKEN }}
7879
yaml-file: .github/labels.yml
79-
skip-delete: false
80-
dry-run: false
8180
exclude: |
8281
help*
8382
*issue
8483
```
8584

86-
With this workflow, the YAML configuration above on a [fresh repository](samples/original.yml), this will:
85+
With this workflow, the YAML configuration above on a [fresh repository](samples/original.yml),
86+
this will:
8787

8888
* Skip `bug` (because same `color` and `description`)
8989
* Skip `documentation` (because same `color` and `description`)
@@ -101,13 +101,12 @@ With this workflow, the YAML configuration above on a [fresh repository](samples
101101

102102
Following inputs can be used as `step.with` keys
103103

104-
| Name | Type | Description |
105-
|----------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
106-
| `github-token` | String | [GitHub Token](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) as provided by `secrets`. (default `${{ github.token }}`) |
107-
| `yaml-file` | String | Path to YAML file containing labels definitions. (default `.github/labels.yml`) |
108-
| `skip-delete` | Bool | If enabled, labels will not be deleted if not found in YAML file. (default `false`) |
109-
| `dry-run` | Bool | If enabled, changes will not be applied. (default `false`) |
110-
| `exclude` | List | Newline delimited list of labels pattern(s)/matcher to exclude |
104+
| Name | Type | Description |
105+
|----------------|--------|-------------------------------------------------------------------------------------|
106+
| `yaml-file` | String | Path to YAML file containing labels definitions. (default `.github/labels.yml`) |
107+
| `skip-delete` | Bool | If enabled, labels will not be deleted if not found in YAML file. (default `false`) |
108+
| `dry-run` | Bool | If enabled, changes will not be applied. (default `false`) |
109+
| `exclude` | List | Newline delimited list of labels pattern(s)/matcher to exclude |
111110

112111
## Contributing
113112

action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ branding:
77
icon: 'tag'
88

99
inputs:
10-
github-token:
11-
description: 'GitHub Token as provided by secrets'
12-
default: ${{ github.token }}
13-
required: true
1410
yaml-file:
1511
description: 'Path to YAML file containing labels definitions'
1612
default: '.github/labels.yml'
@@ -26,6 +22,10 @@ inputs:
2622
exclude:
2723
description: 'Newline-delimited list of labels pattern(s)/matcher to exclude'
2824
required: false
25+
github-token:
26+
description: 'GitHub Token as provided by secrets'
27+
default: ${{ github.token }}
28+
required: true
2929

3030
runs:
3131
using: 'node16'

0 commit comments

Comments
 (0)