fix(ci): generate docs per-schema-file#69
Merged
Conversation
Passing schemas/v3 as a directory caused generate-schema-doc to try processing bibliography.yaml and figure.yaml, which are dataset-syntax files — not valid JSON Schemas (no $id, no type: object). The tool fails with 'Cannot generate documentation since root schema could not be loaded'. Fix: invoke generate-schema-doc once per valid schema file (concept, localized-concept, register for v3; concept, localized-concept for v2). This is also more explicit and extensible — new dataset-syntax files won't break the doc generation.
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
1 participant
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.
The directory-based invocation was failing because
schemas/v3/now containsbibliography.yamlandfigure.yaml, which are dataset-syntax files — not valid JSON Schemas.generate-schema-docfails with 'root schema could not be loaded'.Fix: invoke
generate-schema-doconce per valid schema file. Also more explicit and extensible — adding new dataset-syntax files won't break doc generation.