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

Barebones workflow to trigger pre-commit github action #64

Merged
merged 19 commits into from
Dec 10, 2024

Conversation

jdye64
Copy link
Collaborator

@jdye64 jdye64 commented Sep 9, 2024

Description

Barebones Github Action configuration to install and run pre-commit on the nv-ingest codebase

Developers will need to now make sure that pre-commit is installed in their development environment. This is included in the util-requirements.txt file now or you can simply run pip install pre-commit.

Then you must install the pre-commit hooks with pre-commit install

If you find yourself working on a PR prior to this commit that does not have pre-commit you can skip the pre-commit checks and commit time by running git commit -m "commit without checking" --no-verify

This checks for

  • Trailing whitespaces
  • Fixes end of lines to include a single blank line
  • check that no files larger than 1,500kb are committed. Maybe we adjust later?
  • check that python files are valid
  • format and lint with black to PEP8 standard

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

.github/workflows/pre-commit.yml Outdated Show resolved Hide resolved
@jdye64 jdye64 dismissed jarmak-nv’s stale review December 3, 2024 13:23

no longer relevant

@jdye64 jdye64 merged commit 8a2a202 into NVIDIA:main Dec 10, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants