Skip to content

Commit dacb246

Browse files
committed
docs: Moved all documentation to readme
1 parent b4b6c3c commit dacb246

2 files changed

Lines changed: 58 additions & 61 deletions

File tree

DOCS.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

README.md

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,70 @@ docker run --rm \
1616
-e PLUGIN_DEBUG=true \
1717
-v path/to/yamls:/work \
1818
-w=/work \
19-
devatherock/drone-yaml-validator:latest
19+
devatherock/drone-yaml-validator:1.5.0
2020
```
2121

2222
### CI
23-
Please refer [docs](DOCS.md)
23+
The following parameters can be set to configure the plugin.
24+
25+
* **debug** - Flag to enable debug logs. Optional, by default, debug logs are disabled
26+
27+
* **continue_on_error** - Flag to indicate if processing should continue when an invalid file is encountered. Optional,
28+
defaults to true
29+
30+
* **search_path** - If specified, only YAMLs present in this path will be validated
31+
32+
* **allow_duplicate_keys** - Flag to indicate if YAML files with duplicate keys should be considered valid. Optional,
33+
defaults to false
34+
35+
#### vela
36+
37+
```yaml
38+
steps:
39+
- name: yaml_validator
40+
ruleset:
41+
branch: master
42+
event: push
43+
image: devatherock/vela-yaml-validator:1.5.0
44+
parameters:
45+
debug: false
46+
continue_on_error: true
47+
allow_duplicate_keys: false
48+
```
49+
50+
#### drone
51+
52+
```yaml
53+
steps:
54+
- name: yaml_validator
55+
image: devatherock/drone-yaml-validator:1.5.0
56+
settings:
57+
debug: false
58+
continue_on_error: true
59+
allow_duplicate_keys: false
60+
```
61+
62+
#### CircleCI
63+
64+
```yaml
65+
version: 2.1
66+
jobs:
67+
validate_yamls:
68+
docker:
69+
- image: devatherock/vela-yaml-validator:1.5.0
70+
working_directory: ~/my-repo
71+
environment:
72+
PARAMETER_DEBUG: false
73+
PARAMETER_CONTINUE_ON_ERROR: true
74+
PARAMETER_ALLOW_DUPLICATE_KEYS: false
75+
steps:
76+
- checkout
77+
- run: sh /scripts/entry-point.sh
78+
```
2479
2580
## Tests
2681
To test the latest plugin images, run the below command
82+
2783
```shell
2884
make functional-test
2985
```

0 commit comments

Comments
 (0)