Add pre-commit tool #156
Add pre-commit tool #156
Conversation
In this commit, we add the pre-commit tool to improve the Software Development Lifecycle of the project by automatically running checks (mainly linting & formatting) before one commits their changes. - Specifically: * flake8, isort and black were adjusted in tox to run as a pre-commit hooks * Additionally, added hooks were: - the check-added-large-files - prevents giant files from being committed - end-of-file-fixer - ensures that a file is either empty or ends with one newline - trailing-whitespace - trims trailing whitespace - check-yaml - checks yaml files for parseable syntax * we added a local hook with pre-commit that calls tox to check if `make requirements` is up-to-date - The Pipfile dev-packages were updated to include pre-commit. - We updated the README.md with how to install and enable pre-commit. - We ran `make requirements`. - Fix tox requirements check failing. Signed-off-by: Konstantinos Papadopoulos <[email protected]>
Codecov ReportBase: 92.30% // Head: 92.30% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #156 +/- ##
=======================================
Coverage 92.30% 92.30%
=======================================
Files 16 16
Lines 585 585
=======================================
Hits 540 540
Misses 45 45 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
@KAUTH could you apply the changes we discussed in pr repository-service-tuf/repository-service-tuf-cli#110 here as well? |
- Edited description in README.rst - Added precommit command in the Makefile Signed-off-by: Konstantinos Papadopoulos <[email protected]>
Signed-off-by: Konstantinos Papadopoulos <[email protected]>
There was a problem hiding this comment.
I had a look at the changes and they seem the same as in the repository-service-tuf/repository-service-tuf-cli#110 pr.
@KAUTH I will ask you the same as I mentioned in my comment
repository-service-tuf/repository-service-tuf-worker#114 (review) or create additional two issues in this repo.
|
In this PR, we add the pre-commit tool to
improve the Software Development Lifecycle
of the project by automatically running checks
(mainly linting & formatting) before one commits their changes.
make requirementsis up-to-dateThe Pipfile dev-packages were updated to include pre-commit.
We updated the README.md with how to install and enable pre-commit.
We ran
make requirements.Fix tox requirements check failing.