docs: include some examples, explicitly state success
This commit is contained in:
parent
da85fb3f57
commit
ac6de31e6e
|
@ -3,6 +3,7 @@
|
||||||
.nyc_output/
|
.nyc_output/
|
||||||
node_modules/
|
node_modules/
|
||||||
out/
|
out/
|
||||||
|
package-lock.json
|
||||||
yarn-error.log
|
yarn-error.log
|
||||||
|
|
||||||
*.bak
|
*.bak
|
||||||
|
|
|
@ -19,6 +19,7 @@ vendor/
|
||||||
Dockerfile
|
Dockerfile
|
||||||
licensed.yml
|
licensed.yml
|
||||||
Makefile
|
Makefile
|
||||||
|
package-lock.json
|
||||||
renovate.json
|
renovate.json
|
||||||
tsconfig.json
|
tsconfig.json
|
||||||
yarn-*
|
yarn-*
|
||||||
|
|
21
README.md
21
README.md
|
@ -28,10 +28,23 @@ fields, and other **g**ood stuff.
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
> cat rules/examples/kubernetes-require-resources-pass.yml | salty-dog \
|
> cat rules/examples/kubernetes-require-resources-fail.yml |\
|
||||||
--rules rules/kubernetes.yml \
|
salty-dog \
|
||||||
--source - \
|
--rules rules/kubernetes.yml \
|
||||||
--tag important
|
--source - \
|
||||||
|
--tag important |\
|
||||||
|
./node_modules/.bin/bunyan
|
||||||
|
|
||||||
|
[2019-06-15T23:56:04.764Z] ERROR: salty-dog/22211 on cerberus: some rules failed (errors=1)
|
||||||
|
|
||||||
|
> cat rules/examples/kubernetes-require-resources-pass.yml |\
|
||||||
|
salty-dog \
|
||||||
|
--rules rules/kubernetes.yml \
|
||||||
|
--source - \
|
||||||
|
--tag important |\
|
||||||
|
./node_modules/.bin/bunyan
|
||||||
|
|
||||||
|
[2019-06-15T23:53:34.223Z] INFO: salty-dog/19839 on cerberus: all rules passed
|
||||||
```
|
```
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
|
@ -99,6 +99,7 @@ export async function main(argv: Array<string>): Promise<number> {
|
||||||
return STATUS_ERROR;
|
return STATUS_ERROR;
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
logger.info('all rules passed');
|
||||||
return STATUS_SUCCESS;
|
return STATUS_SUCCESS;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue