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

Fix up examples in src/schema/README.md to not use outdated schema paths #1698

Merged
merged 10 commits into from
Mar 13, 2024

Conversation

yarikoptic
Copy link
Collaborator

@yarikoptic yarikoptic commented Feb 7, 2024

I also developed a script to catch those no longer valid paths used. I think it is worth adding it on CI

  • find where in CI we produce that json dump of the schema, and add there running this script to ensure that all paths in README.md are valid
  • (maybe elsewhere) decide if we should not choose simpler example or may be make it fuller (give example of secondary dereference)

Copy link

codecov bot commented Feb 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.93%. Comparing base (327bece) to head (1c0edcd).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1698   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files          16       16           
  Lines        1351     1351           
=======================================
  Hits         1188     1188           
  Misses        163      163           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yarikoptic
Copy link
Collaborator Author

I found where schema.org is produced -- in RTD, but there in env there is no jq so RTD succeeds but log says

tools/no-bad-schema-paths.sh: line 19: jq: command not found
meta.context.context: not reachable
tools/no-bad-schema-paths.sh: line 19: jq: command not found
objects.columns: not reachable
tools/no-bad-schema-paths.sh: line 19: jq: command not found
objects.common_principles: not reachable
tools/no-bad-schema-paths.sh: line 19: jq: command not found

moreover -- RTD succeeds! so that would not be appropriate place. we need to do it in another CI

@yarikoptic
Copy link
Collaborator Author

yeay -- it worked, removing TEMP commit:

image

@yarikoptic yarikoptic requested a review from effigies March 7, 2024 23:26
@effigies effigies added the exclude-from-changelog This item will not feature in the automatically generated changelog label Mar 13, 2024
@effigies effigies merged commit 2fc8982 into bids-standard:master Mar 13, 2024
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation exclude-from-changelog This item will not feature in the automatically generated changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants