X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=README.md;h=fa5a914410a9dac6e77a115f5ab170683e3f6779;hb=4e5067df3af3dcee506bb94ab35011cbc9cf1924;hp=dbbf0d998331de4b789cca32d0b43d0d02ea5509;hpb=10821edc619b09e4623884b02900c39431f8a809;p=releng%2Fglobal-jjb.git
diff --git a/README.md b/README.md
index dbbf0d99..fa5a9144 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,14 @@ be available.
For example:
```
+GERRIT_URL=https://git.opendaylight.org/gerrit
GIT_URL=ssh://jenkins-$SILO@git.opendaylight.org:29418
GIT_CLONE_URL=git@github.com:
JENKINS_HOSTNAME=jenkins092
LOGS_SERVER=https://logs.opendaylight.org
NEXUS_URL=https://nexus.opendaylight.org
SILO=releng
+SONAR_URL=https://sonar.opendaylight.org
```
Note: Use **GIT_CLONE_URL** for GitHub projects as this
@@ -26,19 +28,35 @@ configuration.
**Required**
-- Config File Provider
-- Description Setter
-- Gerrit Trigger
-- Post Build Script
-- SSH Agent
-- Workspace Cleanup
+- [Config File Provider](https://plugins.jenkins.io/config-file-provider)
+- [Description Setter](https://plugins.jenkins.io/description-setter)
+- [Environment Injector Plugin](https://plugins.jenkins.io/envinject)
+- [Git plugin](https://plugins.jenkins.io/git)
+- [Post Build Script](https://plugins.jenkins.io/postbuildscript)
+
+ Due to security concerns Post Build Script is not available through
+ the Jenkins update center and must install it manually. You can
+ download it
+ [here](https://updates.jenkins-ci.org/download/plugins/postbuildscript/).
+
+- [SSH Agent](https://plugins.jenkins.io/ssh-agent)
+- [Workspace Cleanup](https://plugins.jenkins.io/ws-cleanup)
+
+**Required for Gerrit connected systems**
+
+- [Gerrit Trigger](https://plugins.jenkins.io/gerrit-trigger)
+
+**Required for GitHub connected systems**
+
+- [GitHub plugin](https://plugins.jenkins.io/github)
+- [GitHub Pull Request Builder](https://plugins.jenkins.io/ghprb)
**Optional**
-- Mask Passwords
-- MsgInject
-- OpenStack Cloud
-- Timestamps
+- [Mask Passwords](https://plugins.jenkins.io/mask-passwords)
+- [MsgInject](https://plugins.jenkins.io/msginject)
+- [OpenStack Cloud](https://plugins.jenkins.io/openstack-cloud)
+- [Timestamps](https://plugins.jenkins.io/timestamper)
## Installing global-jjb
@@ -53,7 +71,11 @@ versioned git tags.
# Add the new submodule to ci-management's jjb directory.
# Note: Perform once per ci-management repo.
cd jjb/
- git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
+
+ # For production deployments:
+ git submodule add https://github.com/lfit/releng-global-jjb global-jjb
+ # For test deployments comment the above and uncomment the below
+ # git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
# Checkout the version of global-jjb you wish to deploy.
cd global-jjb
@@ -105,6 +127,16 @@ trigger any job that uses the `lf-infra-github-pr-trigger` macro.
privileges on any job using the `lf-infra-github-pr-trigger`
macro.
+**lftools-version**: Version of lftools to install. Can be a specific version
+like '0.6.1' or a PEP-440 definition.
+For example `<1.0.0` or `>=1.0.0,<2.0.0`.
+
+**mvn-site-id**: Maven Server ID from settings.xml containing the credentials
+to push to a Maven site repository.
+
+**mvn-staging-id**: Maven Server ID from settings.xml containing the credentials
+to push to a Maven staging repository.
+
defaults.yaml:
```
@@ -121,6 +153,8 @@ defaults.yaml:
- zxiiro
github_pr_admin_list:
- tykeal
+ lftools-version: '<1.0.0'
+ mvn-site-id: opendaylight-site
```
## Config File Management
@@ -181,7 +215,6 @@ ci-management.yaml:
project: ci-management
project-name: ci-management
branch: master
- os-cloud-file-id: 'ci-managed-file-id'
build-node: centos7-basebuild-2c-1g
platforms:
@@ -208,8 +241,6 @@ Required parameters:
**project**: is the project repo as defined in source control.
**project-name**: is a custom name to call the job in Jenkins.
**build-node**: is the name of the builder to use when building (Jenkins label).
-**os-cloud-file-id**: is the name of the managed file-id, which contains
-credentials required for packer to spin up build nodes on the cloud provider.
**platforms**: is a list of supported platforms.
**templates**: is a list of supported templates.
@@ -274,6 +305,17 @@ In this method a job can define a globstar for example `**/*.log` which then
causes the archive script to do a globstar search for that pattern and archives
any files it finds matching.
+## Overriding merge and verify triggers
+
+The default trigger conditions for Merge and Verify job types are overrideable
+in a project configuration by overriding the following variables:
+
+- gerrit_merge_triggers
+- gerrit_verify_triggers
+
+These variables take a list of trigger-on values as defined in JJB docs here:
+
+
## Appendix
### ShellCheck