datacontract ci
Run tests for CI/CD pipelines. Emits GitHub Actions annotations and step summary.
datacontract ci [OPTIONS] [LOCATIONS]...
| Argument | Default | Description |
|---|---|---|
[LOCATIONS]... | — | The location(s) (url, s3 url, or local path) of the data contract yaml file(s). |
| Option | Default | Description |
|---|---|---|
--json-schema | — | The location (url or path) of the ODCS JSON Schema |
--server | all | The server configuration to run the schema and quality tests. Use the key of the server object in the data contract yaml file to refer to a server, e.g., production, or all for all servers (default). |
--publish | — | The url to publish the results after the test. |
--output | — | Specify the file path where the test results should be written to (e.g., './test-results/TEST-datacontract.xml'). |
--output-format | — | The target format for the test results. Accepted values: json, junit. |
--metadata-only / --no-metadata-only | --no-metadata-only | Run only checks that read the schema (field presence and types). Checks that read row values are skipped. |
--logs / --no-logs | --no-logs | Print logs |
--json | off | Print test results as JSON to stdout. |
--fail-on | error | Minimum severity that causes a non-zero exit code. |
--ssl-verification / --no-ssl-verification | --ssl-verification | SSL verification when publishing the data contract. |
--custom-quality-checks | — | Folder with the custom quality checks the contract's quality rules use, one YAML file per check. Defaults to DATACONTRACT_CUSTOM_QUALITY_CHECKS. |
--inline-references / --no-inline-references | --inline-references | Resolve authoritativeDefinitions of type definition, semantics or businessDefinition and inline them into the contract. Relative URLs and semantics IRIs are looked up on the ENTROPY_DATA_HOST (default https://api.entropy-data.com), other URLs are fetched directly, file references are read from disk. See https://cli.datacontract.com/semantics |
--debug / --no-debug | — | Enable debug logging |
datacontract ci datacontract.yaml --output test-results.xml --output-format junit
Guide: Scheduling.