diff options
author | Hervé Beraud <hberaud@redhat.com> | 2020-07-21 13:30:43 +0200 |
---|---|---|
committer | Hervé Beraud <hberaud@redhat.com> | 2020-09-22 12:32:18 +0200 |
commit | 80190b395c12aca192f013b076831f3687ccd5a3 (patch) | |
tree | f5de6957087d41b638024faab46f4818baa3e21f /doc | |
parent | 83471a11cc2969617cc08279d0221434a439e5c7 (diff) | |
download | oslo-db-80190b395c12aca192f013b076831f3687ccd5a3.tar.gz |
Adding pre-commit
Introduced changes:
- pre-commit config and rules
- Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit
hooks.
- Applying fixes for pre-commit compliance in all code.
Also commit hash will be used instead of version tags in pre-commit to
prevend arbitrary code from running in developer's machines.
pre-commit will be used to:
- trailing whitespace;
- Replaces or checks mixed line ending (mixed-line-ending);
- Forbid files which have a UTF-8 byte-order marker
(check-byte-order-marker);
- Checks that non-binary executables have a proper
shebang (check-executables-have-shebangs);
- Check for files that contain merge conflict strings
(check-merge-conflict);
- Check for debugger imports and py37+ breakpoint()
calls in python source (debug-statements);
- Attempts to load all yaml files to verify syntax (check-yaml);
- Run flake8 checks (flake8) (local)
For further details about tests please refer to:
https://github.com/pre-commit/pre-commit-hooks
Change-Id: Id03c1ea4752db3236c36521ca9c67125d5ba2526
Co-authored-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--[-rwxr-xr-x] | doc/source/conf.py | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 9b867dc..7006f0d 100755..100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,15 +1,17 @@ -# 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 +# -*- coding: utf-8 -*- +# Copyright (C) 2020 Red Hat, Inc. # -# http://www.apache.org/licenses/LICENSE-2.0 +# 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. # -- General configuration ---------------------------------------------------- |