Chore: Upgrade Jenkins-job-builder to 6.3.0
[releng/global-jjb.git] / docs / job-groups.rst
1 Job groups are a great tool to configure categories of jobs together at the
2 same time. Below the example are some starting point job-groups but we
3 recommend creating your own to ensure that the jobs configured reflect the
4 project's needs.
5
6 An example project:
7
8 .. code-block:: yaml
9
10     - job-group:
11         name: odl-maven-jobs
12
13         jobs:
14           - gerrit-maven-clm
15           - gerrit-maven-merge
16           - gerrit-maven-release
17           - gerrit-maven-verify
18           - gerrit-maven-verify-dependencies:
19               build-timeout: 180
20
21         mvn-version: mvn35
22
23     - project:
24         name: aaa
25         jobs:
26           - odl-maven-jobs
27
28 In this example we are using the job-group to assign a list of common jobs to
29 the aaa project. The job-group also hardcodes ``mvn-version`` to *mvn35* and
30 ``build-timeout`` to *180* for all projects using this job-group.
31
32 A benefit of this method is for example disabling entire category of jobs by
33 modifying the job-group, insert ``disable-job: true`` parameter
34 against the jobs to disable.