Correct annotation python script to correctly work with rfc and iso links #761
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
|
@Julian could you please take a look? I executed the scripts locally with RFC and ISO specs - all looks good now |
|
Let's try it, thanks! |
OptimumCode
commented
Feb 7, 2025
| """ | ||
| Extracts specification number and kind from the defined key | ||
| """ | ||
| can_have_spec = ["rfc", "iso"] |
There was a problem hiding this comment.
note: we could infer that from URITemplate.variable_names by checking if a template has a spec variable (but the ISO template must be configured in that case)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the script cannot process links for rfc and iso - it does not trim the number suffix from a key and it cannot find the right URL template because of that. An example of an unsuccessful run can be found here:
https://github.com/json-schema-org/JSON-Schema-Test-Suite/actions/runs/13163116845/job/36736600257?pr=760
This PR corrects that behaviour and correctly extracts the URL kind and a spec from the key in the
specificationblock. Also, it adds an additional check to avoid a crash in case of an incorrect kind - the error will be reported as an annotation.The URL template for RFC had incorrect spec path - it was also updated (there is also an issue with anchor - txt format does not support them, but this will be changed in a separate PR)