-
-
Notifications
You must be signed in to change notification settings - Fork 279
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
Render conda-forge.yml docs from conda-smithy's JSON schema #2095
Render conda-forge.yml docs from conda-smithy's JSON schema #2095
Conversation
✅ Deploy Preview for conda-forge-previews ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
e86caff
to
938c62d
Compare
…nto json-schema-conda-forge-yml
…nto json-schema-conda-forge-yml
With conda-forge/conda-smithy#1756 merged, this is now pulling from conda-smithy @ main, so this is ready for a final review and merge. cc @conda-forge/core |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm! This is great and thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
mkdir -p "$BASE_DIR/static/schema/" | ||
curl -sL \ | ||
-o "$BASE_DIR/static/schema/conda-forge.schema.json" \ | ||
"https://raw.githubusercontent.com/conda-forge/conda-smithy/main/conda_smithy/data/conda-forge.json" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be main or from the latest release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be from the latest release, but I discussed above with @jaimergp and we decided to punt on latest release for future work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to revisit, but note we have to rebuild the docs no matter what when smithy has a release to get the latest schema.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the "vendored" version should be the released one (so people can use it as an autocomplete driver on their IDE), but then we fetch from main
on every page load. However, there's no release now that features the schema, so we can change this when there's a new release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll merge and once there's a release we can update this line to latest
. We might need an API call for that, or maybe push the file to GH Releases for simplicity 🤔
Do you mean it should just be |
We use arches in |
PR Checklist:
docs/
, you have added it to the sidebar indocs/sidebar.json
This generates lightweight docs for
conda-forge.yml
. JSON Schema is fetched live. No need to rebuild the site if conda-smithy got updated.Preview: https://deploy-preview-2095--conda-forge-previews.netlify.app/docs/maintainer/conda_forge_yml/