-
Notifications
You must be signed in to change notification settings - Fork 23
feat: Consolidate schemas into just schema.json #377
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
Merged
Merged
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
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
…r, do not give in to the Red Hat one
f24848b to
e9bc1df
Compare
This comment was marked as resolved.
This comment was marked as resolved.
|
I ❤️ the diffstat :-) |
quinnallman
approved these changes
Oct 20, 2025
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.
Jira: https://circleci.atlassian.net/browse/PIPE-5316
Description
As described in #372 , this PR takes all the great markdown hover hints from
publicschema.jsonand sticks them inschema.json. It removes any references topublicschema.jsonfrom this repo and deletes the file entirely.This way:
schema.jsonfrom this repo.Implementation details
I attempted to migrate over every description from
publicschema.jsonintoschema.json. The structures between the two differed, and can definitely still use some work but I believe I copied over all of them. Some descriptions here and there. I also improved and fixed some broken documentation links as well.VS Code extension
Opened a PR in the VS Code extension repo that will remove any references to publicschema to reflect the changes here!
How to validate
Two ways this needs to be validated:
Red Hat YAML Language Server: In VS Code, disable the CircleCI extension, make sure you have the Red Hat YAML Language Server installed and enabled. Open up any CircleCI
config.ymlyou have, and put this at the top of the file. This will tell the Red Hat YAML Language Server to fetch theschema.jsonfrom this branch instead of the one from the main branch. Ensure that when you hover overjobs:, orexecutor:you see nice markdown documentation hover tips with links.# yaml-language-server: $schema=https://raw.githubusercontent.com/CircleCI-Public/circleci-yaml-language-server/refs/heads/consolidate-schemas/schema.jsonScreen.Recording.2025-10-16.at.3.13.51.PM.mov
Just the CircleCI YAML Language Server: follow the instructions in HACKING.md to run the language server in VS Code with our mini debug extension. Try hovering over stuff like in the above test and you should still see hover hints.
Doing both of the above proves that this change will display hover hints with (1) just the Red Hat YAML language server installed, or (2) with just the CircleCI language server extension installed.
Other changes
Removed the
/outdir fromeditors/vscode. It wasn't being used anywhere nor any commands were building / updating those .js and .map filesallow orbs to reference a semantic version using parameter interpolation
allow executor resource_class to be a self hosted one