diff options
| author | Hervé Beraud <hberaud@redhat.com> | 2020-08-21 15:12:08 +0200 |
|---|---|---|
| committer | Hervé Beraud <hberaud@redhat.com> | 2020-09-22 12:35:37 +0200 |
| commit | a997f09e5bd9ce98cc57f1a5380453ff167e47ca (patch) | |
| tree | ee280ba8adc343c65c2c81abe7343b5f5bd9b876 /doc | |
| parent | 4bae96d7f7f7f99f1a3d8836c98340644925b2e2 (diff) | |
| download | oslo-messaging-a997f09e5bd9ce98cc57f1a5380453ff167e47ca.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: Ibd0c3d64fdc5c293d9d676d33eab828d9fde971f
Co-authored-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/conf.py | 13 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 2 |
2 files changed, 14 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index f8bd9f9..9225989 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,17 @@ # -*- 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 +# +# 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. # # Configuration file for the Sphinx documentation builder. # diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 97fd328..3ab44fd 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -16,4 +16,4 @@ Reference notification_driver notification_listener serializer - exceptions + exceptions |