Merge "Create job to lock|unlock branches via Gerrit"

[releng/global-jjb.git] / README.md

diff --git a/README.md b/README.md
index dbbf0d9..07c73f9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ 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
@@ -105,6 +106,10 @@ 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. <https://www.python.org/dev/peps/pep-0440/>
+For example `<1.0.0` or `>=1.0.0,<2.0.0`.
+
 defaults.yaml:
 
 ```
@@ -121,6 +126,7 @@ defaults.yaml:
       - zxiiro
     github_pr_admin_list:
       - tykeal
+    lftools-version: '<1.0.0'
 ```
 
 ## Config File Management
@@ -181,7 +187,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 +213,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 +277,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:
+<https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit>
+
 ## Appendix
 
 ### ShellCheck