Skip to content

Replace yamale with python implementation of jsonschema #8549

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

Closed
stsewd opened this issue Oct 1, 2021 · 1 comment · Fixed by #11855
Closed

Replace yamale with python implementation of jsonschema #8549

stsewd opened this issue Oct 1, 2021 · 1 comment · Fixed by #11855
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@stsewd
Copy link
Member

stsewd commented Oct 1, 2021

https://github.com/Julian/jsonschema that looks like a good implementation of json schema in python, we could even replace part of our config validation with that.

We are using yamale only here https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/rtd_tests/tests/test_build_config.py, but we don't use anything from yamale in production which is also weird having yamale only to test the spec (which we don't use).

Also, yamale doesn't have all features from jsonschema (we added comments in the file because of that)
https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/rtd_tests/fixtures/spec/v2/schema.yml

And now our json schema is published in schemastore https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/rtd_tests/fixtures/spec/v2/schema.json, so I think makes more sense to test that schema instead of the one from yamale.

Other parts were we are using yamale is in our docs, we are linking to the yamale spec, we should instead link to the json schema instead, which is more popular.

@stsewd stsewd added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Oct 1, 2021
@humitos
Copy link
Member

humitos commented Oct 4, 2021

👍🏼 on removing things we don't use 😄

astrojuanlu added a commit that referenced this issue Oct 4, 2021
stsewd added a commit that referenced this issue Dec 13, 2024
@stsewd stsewd mentioned this issue Dec 13, 2024
@stsewd stsewd closed this as completed in a8507ee Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants