[OpenStack-Infra] [Openstack-docs] How to openstack-doc-tools in gate jobs for openstack-manuals etc

Andreas Jaeger aj at suse.com
Tue Dec 31 13:49:35 UTC 2013


I'm one step further - thanks for the help with the setup of the tools.

I've tested locally now and like to have the operations-guide gating
with the package but still have some questions on how to do it best.

Currently we're not using tox for gating the operations-guide but
looking at it, I like how this integrates.

Let's do an annotated example - gating operations-guide repository

0) Upload openstack-doc-tools to PyPI (AI: Anne)


1) Create file requirements with this content:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
openstack-doc-tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2) Create tox.ini with content:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[tox]
minversion = 1.6
skipsdist = True

[testenv]
deps = -r{toxinidir}/test-requirements.txt

commands = openstack-doc-test {posargs}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3) Create 4 Jenkins jobs that run the gate jobs as:

tox -- --check-niceness
tox -- --check-build
tox -- --check-syntax
tox -- --check-deletions

4) Enhance run-tox.sh
The file run-tox.sh (from config repo as
modules/jenkins/files/slave_scripts/run-tox.sh) does not allow passing
of extra positional args, so either write a new one or change the
existing one to allow passing of it.
Which option do you prefer?


5) Add gates to zuul configuration


Questions:
* Is that the best way forward or do you have another proposal on how to
  do it?
* What's missing?
* Do I need to add some virtualenv for tox - and how to populate it?

Thanks for any help,
Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the OpenStack-Infra mailing list