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

Render conda-forge.yml docs from conda-smithy's JSON schema #2095

Merged
merged 13 commits into from
Mar 13, 2024

Conversation

jaimergp
Copy link
Member

@jaimergp jaimergp commented Mar 1, 2024

PR Checklist:

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/

Copy link

netlify bot commented Mar 1, 2024

Deploy Preview for conda-forge-previews ready!

Name Link
🔨 Latest commit 40e4c3d
🔍 Latest deploy log https://app.netlify.com/sites/conda-forge-previews/deploys/65f062d6e0269a00083a8dd1
😎 Deploy Preview https://deploy-preview-2095--conda-forge-previews.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jaimergp jaimergp force-pushed the json-schema-conda-forge-yml branch from e86caff to 938c62d Compare March 1, 2024 11:21
@jaimergp jaimergp marked this pull request as ready for review March 1, 2024 13:42
@jaimergp jaimergp requested a review from a team as a code owner March 1, 2024 13:42
@jaimergp jaimergp changed the title Render conda-forge.yml docs from (WIP) JSON schema Render conda-forge.yml docs from conda-smithy's JSON schema Mar 12, 2024
@jaimergp
Copy link
Member Author

jaimergp commented Mar 12, 2024

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

.ci_scripts/update_docs Outdated Show resolved Hide resolved
Copy link
Member

@beckermr beckermr left a 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!

Copy link
Member

@xhochy xhochy left a 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"
Copy link
Member

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?

Copy link
Member

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.

Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Member Author

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 🤔

@h-vetinari
Copy link
Member

This is very cool! 🤩

Was just browsing a bit, but I think the dict for os_version is wrong (contains arches):
image

@jaimergp
Copy link
Member Author

jaimergp commented Mar 13, 2024

Was just browsing a bit, but I think the dict for os_version is wrong (contains arches):

Do you mean it should just be linux? I think it does need the arch. Examples in conda-forge. If it still needs to be corrected, that should happen in the conda-smithy repo.

@jaimergp jaimergp merged commit 7323f49 into conda-forge:main Mar 13, 2024
5 checks passed
@jakirkham
Copy link
Member

We use arches in nccl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

6 participants