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

ReadTheDocs Schema not current? #531

Open
scottyhq opened this issue Feb 28, 2025 · 1 comment
Open

ReadTheDocs Schema not current? #531

scottyhq opened this issue Feb 28, 2025 · 1 comment
Labels
vendored-schema-update Updating a vendored schema

Comments

@scottyhq
Copy link

ReadTheDocs has new configuration options https://docs.readthedocs.com/platform/stable/build-customization.html but in trying their examples I'm running into:

Validate ReadTheDocs Config..............................................Failed
- hook id: check-readthedocs
- exit code: 1

Schema validation errors were encountered.
  .readthedocs.yaml::$.build.jobs: Additional properties are not allowed ('build', 'install' were unexpected)

I think the schema URL might just need updating from 'master' to 'main' here?

"readthedocs": {
"url": _githubusercontent_url(
"readthedocs",
"readthedocs.org",
"master",
"readthedocs/rtd_tests/fixtures/spec/v2/schema.json",

@sirosen sirosen added the vendored-schema-update Updating a vendored schema label Feb 28, 2025
@sirosen
Copy link
Member

sirosen commented Feb 28, 2025

I think the use of master isn't a critical issue, since the RTD repo appears to still be redirecting master to main, but thanks for calling that out.

It looks like there are some changes to the RTD schema this past week. The update cadence for check-jsonschema's vendored schemas is weekly (there's a job that runs on Sundays to open update PRs), but I'm always happy to do an update+release outside of that cycle if it helps keep folks unblocked and I'm able.
I'm assuming that this week's changes are what you need.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
vendored-schema-update Updating a vendored schema
Projects
None yet
Development

No branches or pull requests

2 participants