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: I9b979afcd45e6a51252ccccb686b01beeb9157f8
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
With version 2.1, we renamed options in the extension, let's use them
here as well.
Increase also requirements for reno and Sphinx.
Change-Id: Ica3cc991ad7bcc1626b805ede57c9c23e2538239
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.
Fix problems found by updated hacking version.
Change-Id: I881f5d020d0ea95afb0eab6828928bc386afc263
openstackdocstheme requires reno for testing, but reno requires
openstackdocstheme. To break this, make reno an optional test
requirement.
Change-Id: I267e0216089038a15df8221efc1fcd365e0809be
openstackdocstheme requires os-api-ref for testing, but os-api-ref requires
openstackdocstheme. To break this, make os-api-ref an optional test
requirement.
Change-Id: Ibbd01f63a516a49133cd8cdd4cf0cfe69bbaecaf
- Adds a theme variable, sidebar_dropdown, to set
a dropdown menu for the API references.
To test, uncomment the parameter html_theme_options in
doc/source/conf.py OR build the API Ref demo docs.
- Adds an API Ref docs demo integrating os-api-ref
and openstackdocstheme. Tested with webserver:
python -m SimpleHTTPServer <port_num>.
Change-Id: I346695cd407ecf4efc0a5e00f2c0ccc1ea099ec5
Add reno to automatically generate release notes - the same way other
OpenStack projects do it.
For details see
http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html
This adds a version.py file to request the version of the repo.
Change-Id: Ia009f4cf73bd4188af3a126123d688438b97c994
With the release of pbr 1.0.0, we need a newer version of hacking.
Update the version. hacking is manually synced from global
requirements repo, use the version from there.
See also
http://lists.openstack.org/pipermail/openstack-dev/2015-May/064362.html
Change-Id: Ic3ff9ad74acd57fe149e5873fefe8a99e1d701d8
Hervé Beraud