https://github.com/nrkno/yaml-schema-validator-github-action
A GitHub action that uses Yamale for YAML schema validation
https://github.com/nrkno/yaml-schema-validator-github-action
github-actions schema-validation validation yaml yaml-schema
Last synced: 12 months ago
JSON representation
A GitHub action that uses Yamale for YAML schema validation
- Host: GitHub
- URL: https://github.com/nrkno/yaml-schema-validator-github-action
- Owner: nrkno
- License: mit
- Created: 2020-03-02T10:52:37.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-03T04:32:53.000Z (over 1 year ago)
- Last Synced: 2025-03-05T22:07:49.623Z (over 1 year ago)
- Topics: github-actions, schema-validation, validation, yaml, yaml-schema
- Language: Shell
- Homepage:
- Size: 40 KB
- Stars: 20
- Watchers: 7
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yaml-schema-validator-github-action
A GitHub action that uses [Yamale][] for YAML schema validation.
## Usage
- Filenames are relative to the repository root.
- Disable strict checking by setting `no-strict` to `true`, `1` or `yes`.
- For help with the schema definitions and reference, see [Yamale][].
The following example sets up a check to validate a YAML file in your
repository, *target.yaml*, using a schema defined in *schemas/schema.yaml*:
```
name: YAML schema validator
on: [push]
jobs:
yaml-schema-validation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout
- uses: nrkno/yaml-schema-validator-github-action@v5
with:
schema: schemas/schema.yaml
target: target.yaml
# Uncomment to disable strict checks
# no-strict: true
```
## Versioning
This action is meant to be a wrapper around Yamale, so as of version 4.x
of Yamale, this action will follow Yamale's major version scheme.
To bind the action to a specific release, suffix with `@`.
E.g. `nrkno/yaml-schema-validator-github-action@v4`.
https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses
## Developing
Create and enable a Python virtualenv
```
$ python -m venv venv
$ source venv/bin/activate
```
Install dependencies
```
$ pip install -r requirements.txt
```
Do a test-run with one of the provided examples
```
$ INPUT_SCHEMA=example/schema.yaml \
INPUT_TARGET=example/file-valid-strict.yaml \
./entrypoint.sh
```
[Yamale]: https://github.com/23andMe/Yamale