From 7071de79031407405f85645580ec8bfe9a9f674e Mon Sep 17 00:00:00 2001 From: Al Bailey Date: Mon, 9 Sep 2019 14:26:03 -0500 Subject: [PATCH] Adding zuul jobs for new repo This job adds a single linters tox target. The linters target is an aggregation of linters for this repo including: - bashate - flake8 Note: this repo does not contain any bash or python code, so those linter checks merely protect against future additions of those types of files. Other linters such as yamllint can be added to this repo by later commits. This commit also adds basic contributing and hacking docs. Change-Id: I38531aa125a6004c91a7286eb878eb7b1f188476 Story: 2006166 Task: 36543 Signed-off-by: Al Bailey --- .gitignore | 1 + .zuul.yaml | 8 ++++++++ CONTRIBUTING.rst | 16 ++++++++++++++++ HACKING.rst | 17 +++++++++++++++++ requirements.txt | 1 + test-requirements.txt | 3 +++ tox.ini | 43 +++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 89 insertions(+) create mode 100644 .gitignore create mode 100644 .zuul.yaml create mode 100644 CONTRIBUTING.rst create mode 100644 HACKING.rst create mode 100644 requirements.txt create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..172bf57 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.tox diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..7ccbd0a --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,8 @@ +--- +- project: + check: + jobs: + - openstack-tox-linters + gate: + jobs: + - openstack-tox-linters diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..f2f8e6d --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,16 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in this page: + + https://docs.openstack.org/infra/manual/developers.html + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + https://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed in Launchpad: + + https://bugs.launchpad.net/starlingx diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..e820746 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,17 @@ +StarlingX Helm-Charts Style Commandments +======================================== + +- Step 1: Read the OpenStack style commandments + https://docs.openstack.org/hacking/latest/ +- Step 2: Read on + +Helm-Charts Specific Commandments +--------------------------------- + +None so far + +Running tests +------------- +The approach to running tests is to simply run the command ``tox``. This will +create virtual environments, populate them with dependencies and run all of +the tests that OpenStack CI systems run. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c01ade2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +# Nothing diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..8ae3e22 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,3 @@ +# hacking pulls in flake8 +hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 +bashate >= 0.2 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..575b5e1 --- /dev/null +++ b/tox.ini @@ -0,0 +1,43 @@ +[tox] +envlist = linters +minversion = 2.3 +skipsdist = True +sitepackages=False + +[testenv] +install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} + OS_STDOUT_CAPTURE=1 + OS_STDERR_CAPTURE=1 + OS_DEBUG=1 + OS_LOG_CAPTURE=1 +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +whitelist_externals = + bash + +[testenv:bashate] +# Treat all E* codes as Errors rather than warnings using: -e 'E*' +commands = + bash -c "find {toxinidir} \ + -not \( -type d -name .?\* -prune \) \ + -type f \ + -not -name \*~ \ + -not -name \*.md \ + -name \*.sh \ + -print0 | xargs -r -n 1 -0 bashate -v \ + -e 'E*'" + +[flake8] +max-line-length=80 + +[testenv:flake8] +commands = + flake8 + +[testenv:linters] +commands = + {[testenv:bashate]commands} + {[testenv:flake8]commands}