454992785e4ef4aedb61af0448b061453f26e92f
[releng/global-jjb.git] / README.md
1 <!--- SPDX-License-Identifier: CC-BY-4.0 -->
2 <!--- SPDX-FileCopyrightText: 2017 The Linux Foundation -->
3
4 # Global JJB
5
6 Global-JJB is a library project containing reusable Jenkins Job Builder
7 templates. Developed for LFCI to deploy management Jenkins jobs to an LF
8 managed Jenkins instance, there are other jobs defined which may be helpful
9 to projects that use the same build technology. The intention is to help
10 projects save time from having to define their own job templates.
11
12 ## Guides
13
14 ### [Install](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/)
15
16 -   [Jenkins configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#jenkins-configuration)
17
18 -   [ci-management](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#ci-management)
19
20 -   [Deploy ci-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-ci-jobs)
21
22 -   [Deploy packer-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-packer-jobs)
23
24 ### [Configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html)
25
26 -   [defaults.yaml](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#defaults-yaml)
27
28 -   [Jenkins Files](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-files)
29
30 -   [Jenkins CI Jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-ci-jobs)
31
32 -   [Log Archiving](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#log-archiving)
33
34 ### [Best Practices](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html)
35
36 -   [JJB YAML Layout](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#jjb-yaml-layout)
37
38 -   [Passing parameters to shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#passing-parameters-to-shell-scripts)
39
40 -   [Shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#shell-scripts)
41
42 -   [Usage of config-file-provider](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#usage-of-config-file-provider)
43
44 -   [Preserving Objects in Variable References](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#preserving-objects-in-variable-references)
45
46 -   [Using single quotes around variables](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#using-single-quotes-around-variables)
47
48 -   [Variable expansion and Defaults](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#variable-expansion-and-defaults)
49
50 ## For Detail Documentation [Global-JJB](http://docs.releng.linuxfoundation.org/projects/global-jjb)