-
Notifications
You must be signed in to change notification settings - Fork 303
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
nx-cugraph: automatically generate trees in README.md #4156
Conversation
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.
Thanks for the update! I checked out the new README here and it looks nicer with links for some reason ¯\_(ツ)_/¯
:)
rapids-logger "ensure nx-cugraph autogenerated files are up to date" | ||
pushd python/nx-cugraph | ||
make || true | ||
git diff --exit-code . | ||
git checkout . | ||
popd | ||
|
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 like this check but we should do this as part of pre-commit like we're doing for the rapids-dependency-file-generator
code gen. This will not only ensure the README is up-to-date on commit, but the same check you're doing here will be done as part of the CI style checks automatically. The CI style check is preferred because it fails much faster and has less log output to scroll through.
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.
No strong feelings from me, but adding this as a pre-commit slows down pre-commit for everybody. Could this be switched to a pre-commit hook in a different PR?
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.
Perhaps a "comprimise" would be to add these checks to check_style.sh
, but still not add them to pre-commit. Regardless, I think changing this belongs in a separate PR--no sense delaying this PR further.
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.
Yeah that's also an option that seems better than performing the check as part of a test step. I can do this in an upcoming PR I still need to do to fix the supported python version and CUDA version.
/merge |
This updates how we create trees. Also, CI now tests that auto-generated files are up-to-date (not updating these has gotten me a couple of times).