Skip to content

Commit 884f857

Browse files
committed
Added documentation (and reworked it a bit)
1 parent 972eb39 commit 884f857

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,25 @@ If you want to run it locally on a command line, see the [Buildkite Plugin Linte
2020
2121
## Configuration
2222
23-
### `id`
23+
### Required
24+
25+
#### `id`
2426

2527
The id of the plugin (e.g. `my-org/my-plugin`)
2628

27-
### `image-version`
29+
### Optional
30+
31+
#### `image-version`
2832

2933
The docker tag of the `buildkite/plugin-linter` image to use. Default is `2.0.3`
3034

31-
### `readme` (optional)
35+
#### `readme`
36+
37+
The filename of the plugin’s readme to lint examples on. Default is `README.md`
38+
39+
#### `skip-invalid` (boolean)
3240

33-
The filename of the plugin’s readme. Default is `README.md`
41+
Whether invalid examples (for example with invalid options) should not cause the linting to fail. Defaults to false.
3442

3543
## Developing
3644

0 commit comments

Comments
 (0)