Add pre-commit hooks #1083
Merged
Add pre-commit hooks #1083
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pre-commit (https://pre-commit.com/) is a tool that helps you easily manage pre-commit hooks. We are using this largely for quality control by running tools like flake8 and black.
Fix the versions of black, flake8, and isort in travis so that the same versions are being used to pass/fail the build as developers are using in their pre-commit hooks
Co-authored-by: Shreya Malviya <shreya.malviya@gmail.com>
VakarisZ
reviewed
Apr 7, 2021
VakarisZ
reviewed
Apr 7, 2021
| @@ -24,7 +24,7 @@ install: | |||
| # Python | |||
| - pip freeze | |||
| - pip install -r monkey/monkey_island/requirements.txt # for unit tests | |||
| - pip install flake8 pytest pytest-cov dlint isort # for next stages | |||
| - pip install black==20.8b1 flake8==3.9.0 pytest pytest-cov dlint isort==5.8.0 # for next stages | |||
There was a problem hiding this comment.
Make sure we use the same in our requirement file for island
There was a problem hiding this comment.
pre-commit uses the .pre-commit-config.yaml to track these requirements. I believe it installs them in a virtualenv separate from the rest of the python libraries on the system. You can then run all of the hooks using pre-commit run or pre-commit run -a.
VakarisZ
approved these changes
Apr 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Adds pre-commit config. Resolves #974.
Includes pre-commit hooks for black, flake8, and isort.
PR Checklist
Testing Checklist