Add externalDocs repository/description checks (P-038, P-039) - #410
Merged
hdamker merged 1 commit intoAug 7, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
enhancement/feature
tests
What this PR does / why we need it:
Adds two validation checks for the
externalDocsobject (Design Guide §5.4):P-038warns on a missing or wrongexternalDocs.url;P-039hints whendescriptiondoesn't match the required text. Both compare againstcamaraproject, so a fork run gives the same result as upstream.Checked against all current CAMARA API definitions: 14
P-038and 38P-039findings, all pre-existing.Which issue(s) this PR fixes:
Fixes #409
Special notes for reviewers:
Local checks run:
python3 -m pytest validation/tests/test_python_checks_externaldocs.py -qpython3 -m pytest validation/tests/test_rule_metadata_integrity.py -qpython3 -m pytest validation/tests -q(1228 passed; 3 pre-existing failures intest_yaml_parser_conformance.py, unrelated to this change)Changelog input
Additional documentation
This section can be blank.