This repository has been archived by the owner on Sep 20, 2024. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is adding pre-commit to OpenPype. It comes with pre-configured checks:
trailing-whitespace
check for trailing whitespace
end-of-file-fixer
check if there is no new line at the end of the file
check-yaml
check yaml syntax
check-added-large-files
check if newly added files are larger than 500 Kb (default value)
no-commit-to-branch
check that the commit goes to sane branch defined with following regex:
so that will prevent accidental commits to main, develop and various custom branch names. Only allowed branch prefixes are:
enhancement, feature, bugfix, documentation, tests, local
and lastly it is running the code against black.
More can be added to
.pre-commit-config.yaml
Installation
You can either run
create_env
script, or manually run./.poetry/bin/poetry run pre-commit install
.