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

nx-cugraph: automatically generate trees in README.md #4156

Merged
merged 9 commits into from
Feb 27, 2024

Conversation

eriknw
Copy link
Contributor

@eriknw eriknw commented Feb 8, 2024

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).

@eriknw eriknw changed the title nx-cugraph: automatically generate tables in README.md nx-cugraph: automatically generate trees in README.md Feb 9, 2024
Copy link
Contributor

@rlratzel rlratzel left a 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 ¯\_(ツ)_/¯ :)

.gitignore Outdated Show resolved Hide resolved
.pre-commit-config.yaml Show resolved Hide resolved
Comment on lines +152 to +158
rapids-logger "ensure nx-cugraph autogenerated files are up to date"
pushd python/nx-cugraph
make || true
git diff --exit-code .
git checkout .
popd

Copy link
Contributor

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.

Copy link
Contributor Author

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?

Copy link
Contributor Author

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.

Copy link
Contributor

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.

python/nx-cugraph/Makefile Show resolved Hide resolved
python/nx-cugraph/scripts/update_readme.py Show resolved Hide resolved
@rlratzel rlratzel added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Feb 26, 2024
@rlratzel
Copy link
Contributor

/merge

@rapids-bot rapids-bot bot merged commit 6efb1c6 into rapidsai:branch-24.04 Feb 27, 2024
109 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci improvement Improvement / enhancement to an existing function non-breaking Non-breaking change python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants