summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2020-09-22 12:34:33 +0000
committerGerrit Code Review <review@openstack.org>2020-09-22 12:34:33 +0000
commit51324b276a8a5f69847d3a17fa89924dabad4759 (patch)
tree596408d3a69b4d5b482dea744879dfb1405371bf
parenta900edfff1cb55f1447c7a987d5870f21ce5d5eb (diff)
parentad42c89f3be22c6e061c2da52bcd8cecdb665bc8 (diff)
downloadoslo-log-51324b276a8a5f69847d3a17fa89924dabad4759.tar.gz
Merge "Adding pre-commit"
-rw-r--r--.pre-commit-config.yaml35
-rw-r--r--doc/source/conf.py2
-rw-r--r--releasenotes/source/conf.py2
-rw-r--r--test-requirements.txt2
-rw-r--r--tox.ini2
5 files changed, 42 insertions, 1 deletions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..9d94556
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,35 @@
+# We from the Oslo project decided to pin repos based on the
+# commit hash instead of the version tag to prevend arbitrary
+# code from running in developer's machines. To update to a
+# newer version, run `pre-commit autoupdate` and then replace
+# the newer versions with their commit hash.
+
+default_language_version:
+ python: python3
+
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: ebc15addedad713c86ef18ae9632c88e187dd0af # v3.1.0
+ hooks:
+ - id: trailing-whitespace
+ # Replaces or checks mixed line ending
+ - id: mixed-line-ending
+ args: ['--fix', 'lf']
+ exclude: '.*\.(svg)$'
+ # Forbid files which have a UTF-8 byte-order marker
+ - id: check-byte-order-marker
+ # Checks that non-binary executables have a proper shebang
+ - id: check-executables-have-shebangs
+ # Check for files that contain merge conflict strings.
+ - id: check-merge-conflict
+ # Check for debugger imports and py37+ breakpoint()
+ # calls in python source
+ - id: debug-statements
+ - id: check-yaml
+ files: .*\.(yaml|yml)$
+ - repo: https://gitlab.com/pycqa/flake8
+ rev: 181bb46098dddf7e2d45319ea654b4b4d58c2840 # 3.8.3
+ hooks:
+ - id: flake8
+ additional_dependencies:
+ - hacking>=3.0.1,<3.1.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f9127aa..4ae81f6 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Red Hat, Inc.
+#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 93f889b..627699d 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Red Hat, Inc.
+#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
diff --git a/test-requirements.txt b/test-requirements.txt
index ac16453..0dd4bbc 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -14,3 +14,5 @@ coverage>=4.5.1 # Apache-2.0
bandit>=1.6.0,<1.7.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD
+
+pre-commit>=2.6.0 # MIT
diff --git a/tox.ini b/tox.ini
index bd35d3d..2b3dd76 100644
--- a/tox.ini
+++ b/tox.ini
@@ -17,7 +17,7 @@ commands =
[testenv:pep8]
commands =
- flake8
+ pre-commit run -a
# Run security linter
bandit -r oslo_log -x tests -n5