diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..528b53d --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,16 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.5.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-yaml + - id: check-added-large-files +- repo: https://github.com/PyCQA/pylint + rev: pylint-2.5.0 + hooks: + - id: pylint +- repo: https://github.com/jorisroovers/gitlint + rev: v0.13.1 + hooks: + - id: gitlint diff --git a/Pipfile b/Pipfile index fba1249..6529768 100644 --- a/Pipfile +++ b/Pipfile @@ -12,6 +12,7 @@ fire = "*" configparser = "*" gitlint = "*" pylint = "*" +pre-commit = "*" [requires] python_version = "3.7" diff --git a/README.md b/README.md index e2dd645..5233ebc 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,15 @@ Script for a automatic update of gitea. Should be run locally on the gitea serve * Get latest Release via GitHub API * Check if there is a newer Version * If there is a newer Version: - * If binary file was selected: + * If binary file was selected: * Download new version * Check sha256 * Overwrite old version - * If build from source is active: + * If build from source is active: * Checkout new release branch * Build binary * Overwrite old binary - + ## General Information License: GNU General Public License @@ -67,10 +67,16 @@ The following instructions help you for developing. * Clone this git repo * Install pipenv: `pip install pipenv` * Install all dependencies: `pipenv install` +* Install git pre-commit hooks (for pylint and gitlint) with `pre-commit install` * You can run the tests with `python -m unittest` +* After pushing, you should check the build status which currently checks the tests, pylint and the commit message format. + +### Notes + +The following steps are automatically executed via pre-commit hooks. + * You can run pylint with `pylint gitea_auto_update` * After changes and commit, you can check if your commit message follows the contribution guidelines with `gitlint`. If there is a problem, gitlint will show you a error message. -* After pushing, you should check the build status which currently checks the tests, pylint and the commit message format. ## Contributors