diff --git a/README.md b/README.md index 3e1131c96..b82af8dc6 100644 --- a/README.md +++ b/README.md @@ -258,7 +258,17 @@ Unpublished/ - Keep an eye on the PR to make sure the automated checks pass, as well as to respond to any comments from reviewers. - If you need to make further changes, simply checkout your branch (`git checkout `), make your changes, and commit and push them — the PR will automatically update and re-run validation. -16) GitHub will automatically validate your changes when a PR is opened. If you did not include a results.csv, the check will fail — run the rule locally and push the generated results.csv to resolve it. If a difference between your results.csv and the engine output is detected, the check will also fail — re-run the rule locally, verify the results look correct, and push the updated results.csv. If the check continues to fail after updating, flag it for the Engineers Team in the PR comments. +16) GitHub will automatically validate your changes when a PR is opened. If you did not include a results.csv, the check will fail — run the rule locally and push the generated results.csv to resolve it. If a difference between your results.csv and the engine output is detected, the check will also fail — re-run the rule locally, verify the results look correct, and push the updated results.csv. If the check continues to fail after updating, flag it for the Engineers Team in the PR comments. + + **Rule Schema Validation** will run and post a comment on the PR showing whether your `rule.yaml` is valid. If the schema check fails, the comment will show the specific validation error — for example, the image below shows a failure caused by an empty `check all:` condition in the rule. The comment will automatically update when you push new code and the action re-runs. + + ![Schema validation failure example](docs/files/schema.png) + + **Test Data Validation** will also run and post a comment showing the results of running the rule against your test data. If the check fails, the comment will indicate why — for example, the image below shows a failure caused by a missing `.env` file in the test data. + + ![Test data validation failure example](docs/files/validation.png) + +Once your rule and test data pass these checks, the PR can be merged. **Approval - Merge PR** diff --git a/docs/files/schema.png b/docs/files/schema.png new file mode 100644 index 000000000..fcdddc30b Binary files /dev/null and b/docs/files/schema.png differ diff --git a/docs/files/validation.png b/docs/files/validation.png new file mode 100644 index 000000000..41163223a Binary files /dev/null and b/docs/files/validation.png differ diff --git a/engine b/engine index 9c4584033..631e708fc 160000 --- a/engine +++ b/engine @@ -1 +1 @@ -Subproject commit 9c4584033f8c83e40fe39ba7145f3340aaaefa9d +Subproject commit 631e708fc815932d8e9adbad334a8eb506e17f8d