- $ python scripts/jjb-init-project.py --help
- usage: jjb-init-project.py [-h] [-c CONF] [-d DEPENDENCIES] [-t TEMPLATES]
- [-s STREAMS] [-p POM] [-g MVN_GOALS] [-o MVN_OPTS]
- [-a ARCHIVE_ARTIFACTS]
- project
-
- positional arguments:
- project project
-
- optional arguments:
- -h, --help show this help message and exit
- -c CONF, --conf CONF Config file
- -d DEPENDENCIES, --dependencies DEPENDENCIES
- Project dependencies A comma-seperated (no spaces)
- list of projects your project depends on. This is used
- to create an integration job that will trigger when a
- dependent project-merge job is built successfully.
- Example: aaa,controller,yangtools
- -t TEMPLATES, --templates TEMPLATES
- Job templates to use
- -s STREAMS, --streams STREAMS
- Release streams to fill with default options
- -p POM, --pom POM Path to pom.xml to use in Maven build (Default:
- pom.xml
- -g MVN_GOALS, --mvn-goals MVN_GOALS
- Maven Goals
- -o MVN_OPTS, --mvn-opts MVN_OPTS
- Maven Options
- -a ARCHIVE_ARTIFACTS, --archive-artifacts ARCHIVE_ARTIFACTS
- Comma-seperated list of patterns of artifacts to
- archive on build completion. See:
- http://ant.apache.org/manual/Types/fileset.html
-
-If all your project requires is the basic verify, merge, and daily jobs then
-using the job template should be all you need to configure for your jobs.
-
-Auto-Update Job Templates
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The first line of the job YAML file produced by the `jjb-init-project.py`_ script will
-contain the words `# REMOVE THIS LINE IF...`. Leaving this line will allow the
-RelEng/Builder `jjb-autoupdate-project.py`_ script to maintain this file for your project,
-should the base templates ever change. It is a good idea to leave this line if
-you do not plan to create any complex jobs outside of the provided template.
-
-However, if your project needs more control over your jobs or if you have any
-additional configuration outside of the standard configuration provided by the
-template, then this line should be removed.
-
-Tuning Templates
-""""""""""""""""
-
-Allowing the auto-updated to manage your templates doesn't prevent you from
-doing some configuration changes. Parameters can be passed to templates via
-a `<project>.cfg` in your `builder/jjb/<project>` directory. An example is
-provided below, others can be found in the repos of other projects. Tune as
-necessary. Unnecessary paramaters can be removed or commented out with a "#"
-sign.
+ <tr class="warning">
+ <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
+ <td><b>Gerrit Trigger</b><br/>recheck</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ This job template can be used by a project that uses Tox to build. It
+ simply installs a Python virtualenv and uses tox to run the tests
+ defined in the project's tox.ini file. If the tox.ini is anywhere
+ other than the project's repo root, the path to its directory
+ relative to the project's repo root should be passed as {toxdir}.
+
+ The 2 template names verify-python & verify-tox are identical and are
+ aliases to each other. This allows the project to use the naming that
+ is most reasonable for them.
+ </td>
+ </tr>