diff options
author | Hervé Beraud <hberaud@redhat.com> | 2020-07-21 13:33:41 +0200 |
---|---|---|
committer | Hervé Beraud <hberaud@redhat.com> | 2020-09-22 11:17:45 +0200 |
commit | d023c60c7427a8e582491723c28350d44335f248 (patch) | |
tree | 46dd72fd0d3ceed99d962afcf3a6ebcce604e25c /doc/source/configuration | |
parent | 17ada34571427fbe3b44bcf35ef773c78ca70b5d (diff) | |
download | oslo-middleware-d023c60c7427a8e582491723c28350d44335f248.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: Ifc5ee35d399c628604ec1644eb447936803c45f5
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Diffstat (limited to 'doc/source/configuration')
-rw-r--r-- | doc/source/configuration/index.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 6ca076e..0a2a4ec 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -3,7 +3,7 @@ Middlewares and configuration ============================= Middlewares can be configured in multiple fashion depending of the -application needs. Here is some use-cases: +application needs. Here is some use-cases: Configuration from the application ---------------------------------- @@ -24,8 +24,8 @@ The paste filter (in /etc/my_app/api-paste.ini) will looks like:: [filter:sizelimit] use = egg:oslo.middleware#sizelimit - # In case of the application doesn't use the global oslo.config - # object. The middleware must known the app name to load + # In case of the application doesn't use the global oslo.config + # object. The middleware must known the app name to load # the application configuration, by setting this: # oslo_config_project = my_app |