pre-commit framework

+ add pre-commit framework to reduce the amount the ci workers have to stem
This commit is contained in:
nico 2020-09-18 21:32:23 +02:00
parent bf49087072
commit b113b9ce60
Signed by: mightyBroccoli
GPG Key ID: EA7C31AAB1BDC1A2
3 changed files with 41 additions and 0 deletions

27
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,27 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: check-docstring-first
- id: check-executables-have-shebangs
- id: check-yaml
files: config.yml
- id: debug-statements
- id: end-of-file-fixer
- id: fix-encoding-pragma
- id: mixed-line-ending
args:
- "--fix=lf"
- id: trailing-whitespace
- repo: https://github.com/psf/black
rev: 19.10b0
hooks:
- id: black
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.3
hooks:
- id: flake8

View File

@ -116,3 +116,16 @@ The potential reasons are sorted by probability of being the root cause.
| code | potential reason |
| :---: | :---|
| 17 | login credential mismatch, potential api permission problem |
### pre-commit framework
This project utilizes the [pre-commit](https://pre-commit.com/) framework to automate various small hick-ups that tend
to happen prior to committing.
To use the framework it is necessary to follow these steps:
```bash
# install the pre-commit hook
pre-commit install
# to test your staged files manually run
pre-commit run
```

View File

@ -4,3 +4,4 @@ requests>=2.21.0
packaging>=20.1
ruamel.yaml==0.16.10
ruamel.yaml.clib==0.2.0
pre-commit==2.7.1