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

Pipeline to check the Correctness of Schemas, Shapes, and Examples #180

Open
sebbader-sap opened this issue Nov 29, 2023 · 4 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@sebbader-sap
Copy link
Contributor

While updating the documents, we sometimes miss to touch all affected files, or add typos when touching example or schema files. Having a pipeline that checks the correctness will significantly increase the quality of the protocol.

Proposal:

  1. Check all JSON Schema files that they are correct JSON Schema by simply loading them into a JSON Schema Validator. Parsing successful --> schema files are syntactically correct.
  2. Check all SHACL files by loading them into a SHACL Validator. Parsing successful --> shape files are syntactically correct.
  3. Validate all example files against both the JSON Schemas and the Shapes.

A PR can only be merged if all three checks are successful.

@sebbader-sap
Copy link
Contributor Author

Github Actions provide many of the required features. We need to create a PoC to see if anything is missing.

@sebbader-sap sebbader-sap self-assigned this Nov 29, 2023
@sebbader-sap sebbader-sap added the enhancement New feature or request label Nov 29, 2023
@sebbader-sap
Copy link
Contributor Author

Update: General JSON Schema validation works, however, not yet for more than one JSON file.

@sebbader-sap
Copy link
Contributor Author

@ssteinbuss please move this issue to the new repo. No further activity will happen in this one. The proposed solution will work also in the new repo as long as the folder structure and file naming convention won't be changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant