add rapids-dependency-file-generator pre-commmit hook

[jameslamb]

Proposes adding a pre-commit hook to run rapids-dependency-file-generator.

With that change, local pre-commit and CI will raise an error if changes have been made in dependencies.yaml that would affect any other files checked into the repo, like the conda envs in https://github.com/rapidsai/cucim/tree/branch-24.02/conda/environments.

How I tested this

Changed a cmake version constraint in dependencies.yaml.

Ran pre-commit run --all-files.

Observed the expected failure.

Reverted that change, ran pre-commit run --all-files again, saw everything pass.

[bdice]

@jameslamb Also FYI: rapidsai/shared-workflows#46 (comment)

There's a list of a few repos needing this update.

[bdice]

Also we can disable the dependency check from the checks job now that it's covered by style checks.

Like this in .github/workflows/pr.yaml:

  checks:
    secrets: inherit
    uses: rapidsai/shared-action-workflows/.github/workflows/[email protected]
    with:
      enable_check_generated_files: false

Example: https://github.com/rapidsai/cudf/pull/12819/files

[jakirkham]

Regarding adding enable_check_generated_files. Would we actually just make that false by default (or drop that flag altogether) once pre-commit support for rdfg is added throughout RAPIDS?

[bdice]

Regarding adding enable_check_generated_files. Would we actually just make that false by default (or drop that flag altogether) once pre-commit support for rdfg is added throughout RAPIDS?

Yes. After we add pre-commit hooks we can change the default to false and later remove that option.

[jameslamb]

Also FYI: rapidsai/shared-workflows#46 (comment)

There's a list of a few repos needing this update.

Thanks! Hadn't seen that before! I can make those changes in those other repos right now, shouldn't take that long.

Also we can disable the dependency check from the checks job now that it's covered by style checks.

done in 4cf17d3

[jameslamb]

done in 4cf17d3

On second thought... I just reverted that.

@bdice instead of checking in configuration like this in all the repos:

with:
      enable_check_generated_files: false

I think it'd be preferable to just add those pre-commit hooks to the remaining repos, and then remove the rapids-dependency-file-generator functionality entirely from the configuration of checks in shared-workflows.

That'd avoid the need to come back and do another round of PRs removing the with: enable_check_generated_files from configs here. Re-reading it, I think that's what @jakirkham was implying in #682 (comment) too.

What do you think?

[bdice]

That'd avoid the need to come back and do another round of PRs

That is smarter. Do that!

[jakirkham]

Yep thinking the same thing. We can apply those cycles to some other goal

[jameslamb]

I can make those changes in those other repos right now

This didn't happen. I did search for which ones need it and summarized that at rapidsai/shared-workflows#46 (comment).

[jakirkham]

/merge

[jakirkham]

Thanks all! 🙏