Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nhalstead committed Nov 29, 2020
1 parent d58fc15 commit f040900
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This project uses [`ajv`](https://github.com/epoberezkin/ajv), fast JSON schema
### Inputs

- `schema`: Relative file path under the repository of a JSON schema file to validate the other JSON files with. Default is: `'./schema.json'`.
- `jsons`: One or more relative file paths under the repository (seperated by comma) of the JSON files to validate with the schema provided.
- `jsons`: One or more relative file paths under the repository (separated by commas) of the JSON files to validate with the schema provided.

> Note: `schema` is **required**, otherwise default will be used.
### Outputs

- `invalid`: One or more of relative file paths of the invalid JSON files, found in the repository (seperated by comma).
- `invalid`: One or more of relative file paths of the invalid JSON files, found in the repository (separated by commas).

### Example Workflow

Expand All @@ -31,19 +31,10 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Validate JSON
uses: docker://orrosenblatt/validate-json-action:latest
uses: docker://nhalstead00/validate-json-action:latest
env:
INPUT_SCHEMA: /path/to/schema.json
INPUT_JSONS: /path/to/file.json,/path/to/another/file.json
```
## TODOs
- [x] Initial validation action
- [x] Docker
- [ ] Automate release process
- [ ] Github workflow screenshots
- [ ] Support `exclude` & `include` in PRs (JSONs from pattern)
- [ ] Support `schema` & `jsons` by external reference (from S3/GitHub/etc...)
- [ ] Support `delimiter` input

0 comments on commit f040900

Please sign in to comment.