feat: add rules to image, doc
This commit is contained in:
parent
da4274966a
commit
e3588577ac
10
Dockerfile
10
Dockerfile
|
@ -1,11 +1,11 @@
|
||||||
FROM node:11-stretch
|
FROM node:11-stretch
|
||||||
|
|
||||||
COPY docs/config-stderr.yml /root/.salty-dog.yml
|
# copy config and rules, which change rarely
|
||||||
|
COPY docs/config-docker.yml /root/.salty-dog.yml
|
||||||
|
COPY rules /rules
|
||||||
|
|
||||||
|
# copy package and bundle, which change often
|
||||||
COPY package.json /salty-dog/package.json
|
COPY package.json /salty-dog/package.json
|
||||||
COPY out/bundle.js /salty-dog/out/bundle.js
|
COPY out/bundle.js /salty-dog/out/bundle.js
|
||||||
|
|
||||||
WORKDIR /salty-dog
|
|
||||||
|
|
||||||
ENV PATH "${PATH}:/usr/local/lib/node_modules"
|
|
||||||
|
|
||||||
ENTRYPOINT [ "node", "/salty-dog/out/bundle.js" ]
|
ENTRYPOINT [ "node", "/salty-dog/out/bundle.js" ]
|
|
@ -8,6 +8,7 @@ Or, as an acronym, JSON **s**chema **a**nalysis, **l**inting, and **t**ransforma
|
||||||
- [SALTY DOG](#salty-dog)
|
- [SALTY DOG](#salty-dog)
|
||||||
- [Build](#build)
|
- [Build](#build)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
|
- [Docker](#docker)
|
||||||
- [Validate](#validate)
|
- [Validate](#validate)
|
||||||
- [Validate File](#validate-file)
|
- [Validate File](#validate-file)
|
||||||
- [Validate URL](#validate-url)
|
- [Validate URL](#validate-url)
|
||||||
|
@ -57,6 +58,14 @@ ingress.extensions/gitlab created (dry run)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
The Docker container is published for each branch and tag, using the slug (`.` replaced with `-`, mostly). The latest
|
||||||
|
semi-stable image is `ssube/salty-dog:master`.
|
||||||
|
|
||||||
|
Rules are located in `/rules` within the image. To add your own rules, mount them with
|
||||||
|
`-v ${HOME}/your-rules:/user-rules:ro` and include with `--rules /user-rules/rules.yml`.
|
||||||
|
|
||||||
### Validate
|
### Validate
|
||||||
|
|
||||||
`salty-dog` can validate JSON and YAML from files and streams, and emit it to a file or stream (with logs going
|
`salty-dog` can validate JSON and YAML from files and streams, and emit it to a file or stream (with logs going
|
||||||
|
|
|
@ -0,0 +1,7 @@
|
||||||
|
data:
|
||||||
|
logger:
|
||||||
|
level: info
|
||||||
|
name: salty-dog
|
||||||
|
streams:
|
||||||
|
- level: info
|
||||||
|
path: /tmp/salty-dog.log
|
|
@ -1,9 +0,0 @@
|
||||||
data:
|
|
||||||
logger:
|
|
||||||
level: debug
|
|
||||||
name: salty-dog
|
|
||||||
streams:
|
|
||||||
- level: warn
|
|
||||||
stream: !stream stderr
|
|
||||||
- level: debug
|
|
||||||
path: /tmp/salty-dog-debug.log
|
|
|
@ -17,7 +17,7 @@ const RULE_OPTION: Options = {
|
||||||
type: 'array',
|
type: 'array',
|
||||||
};
|
};
|
||||||
|
|
||||||
const MAIN_ARGS = usage(`Usage: $0 <mode> [options]`)
|
const MAIN_ARGS = usage(`Usage: salty-dog <mode> [options]`)
|
||||||
.option(CONFIG_ARGS_NAME, {
|
.option(CONFIG_ARGS_NAME, {
|
||||||
default: `.${VERSION_INFO.app.name}.yml`,
|
default: `.${VERSION_INFO.app.name}.yml`,
|
||||||
group: 'Config:',
|
group: 'Config:',
|
||||||
|
@ -35,6 +35,7 @@ const MAIN_ARGS = usage(`Usage: $0 <mode> [options]`)
|
||||||
.option('count', {
|
.option('count', {
|
||||||
alias: ['c'],
|
alias: ['c'],
|
||||||
default: false,
|
default: false,
|
||||||
|
desc: 'Exit with error count',
|
||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
})
|
})
|
||||||
.option('dest', {
|
.option('dest', {
|
||||||
|
@ -56,6 +57,7 @@ const MAIN_ARGS = usage(`Usage: $0 <mode> [options]`)
|
||||||
.option('rules', {
|
.option('rules', {
|
||||||
alias: ['r'],
|
alias: ['r'],
|
||||||
default: [],
|
default: [],
|
||||||
|
desc: 'Rules file',
|
||||||
type: 'array',
|
type: 'array',
|
||||||
})
|
})
|
||||||
.option('source', {
|
.option('source', {
|
||||||
|
|
Loading…
Reference in New Issue