During the last weeks, I expanded the tools so that they handle also the API project repositories like api-sites and volume-api (the published versions are found via http://api.openstack.org/). The tools found many problems in the current API projects, including some projects that did not even built. The errors found by these are a clear sign that we do need these gating jobs. Diane Fleming and myself fixed the problems that the validation tool found. A small number of problems are still being worked on but all repositories build again and are setup for using the new gates.
Since yesterday, the api-sites repository uses this new tool for gating!
Validating your changesIf you like to run the gates locally: Install the python tox package and run 'tox' from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs. If you like to run individual tests, run:
- 'tox -e checkniceness' - to run the niceness tests
- 'tox -e checksyntax' - to run syntax checks
- 'tox -e checkdeletions' - to check that no deleted files are referenced
- 'tox -e checkbuild' - to actually build the manual(s)
Note that the tools need the maven package as requirement, so install that one as well.
Additionally, these gates will replace the existing gates for the openstack-manual and operations-guide repositories. Once this is done via have for all repositories the same setup and just a single repository with all the validation tools.
openstack-doc-tools repositoryThe repository can be downloaded as a Python package from pypi and currently contains tools for:
- validation/gating: as explained above
- translated documents: Tom Fifieldt is looking on enhancing and using these now.
- Autogeneration of tables: Shaun McCance is enhancing these to nicely generate configuration tables of options specified in the various conf files like nova.conf.
- cleanup tools: Those can be used to remove some whitespace.