Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSON Schema and JSON Validation CI #99

Merged
merged 3 commits into from
Sep 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/json-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Validate JSON files
on:
pull_request:
paths:
- '**.json'
jobs:
setup-validate-json:
name: Setup Validate JSON
runs-on: ubuntu-latest
outputs:
json-to-validate: ${{ steps.get-json.outputs.json }}
steps:
- uses: actions/checkout@v3
- name: Get all schema
id: get-json
# this command finds all the filenames with the '.schema.json' extension, removes that extension, then turns them into a json array
# an example of this transformation would be: 'compilers.schema.json models.schema.json' -> 'compilers models' -> '["compilers","models"]'
run: echo "json=$(find containers/ -type f -name '*.schema.json' | xargs basename -s .schema.json | jq -Rcn '[inputs]')" >> $GITHUB_OUTPUT

validate-json:
name: Validate JSON
runs-on: ubuntu-latest
needs:
- setup-validate-json
strategy:
fail-fast: false
matrix:
file: ${{ fromJson(needs.setup-validate-json.outputs.json-to-validate) }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: Validate files
run: jsonschema -i containers/${{ matrix.file }}.json containers/${{ matrix.file }}.schema.json

22 changes: 22 additions & 0 deletions containers/compilers.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Compilers",
"description": "A list of compilers that are supported",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"package": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [ "name", "package", "version" ],
"additionalProperties": false
}
}
14 changes: 14 additions & 0 deletions containers/models.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Models",
"description": "A list of ACCESS-NRI Models that are supported",
"type": "object",
"patternProperties": {
"^.*$": {
"type": "array",
"items": {
"type": "string"
}
}
}
}