CI: Deprecate Jenkins Sonar jobs

[ci-management.git] / README.md

diff --git a/README.md b/README.md
index c1d0e50..2f70774 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,28 @@
 # Continuous Integration for O-RAN SC at LF
 
-This repo contains configuration files for Jenkins jobs for the O-RAN
-SC project.
+This repo contains configuration files for Jenkins jobs for the
+O-RAN SC project.
 
-## Custom JJB templates for Docker Java projects
+## Defaults.yaml
 
-Custom JJB templates are defined for projects that use Maven to
-compile Java code and build a Docker image.  These projects should use
-the following jobs in the project.yaml file::
+To avoid repetition, many required configuration parameter values
+are defined in the defaults.yaml file.
 
-    jobs:
-      - gerrit-maven-docker-verify
-      - gerrit-maven-docker-merge
-      - gerrit-maven-docker-stage
+## Custom JJB templates for Docker CI PackageCloud projects
+
+Custom JJB templates are defined for projects that use Docker to
+compile code and build DEB/RPM packages, then push the packages to
+PackageCloud.io. These projects should use the following jobs in
+their respective project.yaml file::
 
+    jobs:
+      - gerrit-docker-verify
+      - oran-gerrit-docker-ci-pc-merge
 
 ## Testing the templates
 
 These instructions explain how to test the templates using the Jenkins
-sandbox.  This catches errors before submitting the changes as Gerrit
+sandbox. This catches errors before submitting the changes as Gerrit
 reviews.
 
 ### Prerequisites
@@ -45,10 +49,10 @@ oran-jenkins-sandbox-access) at the Jenkins sandbox:
     https://jenkins.o-ran-sc.org/sandbox
 
 Get the authentication token from the sandbox:
-    a) click on your user name (top right)
-    b) click Configure (left menu)
-    c) under API Token, click Add new Token (button)
-    d) copy the token string
+a) click on your user name (top right)
+b) click Configure (left menu)
+c) under API Token, click Add new Token (button)
+d) copy the token string
 
 Create a config file jenkins.ini using the following template and your
 credentials (user name and API token from above)::
@@ -78,13 +82,13 @@ parameters" in left menu.
 ### How to build from a Gerrit review branch
 
 This explains how to launch a "verify" job in the Sandbox on an open
-review.  Most "verify" jobs accept parameters to build code in a
-review submitted to Gerrit.  You must specify the change ref spec,
-which is a Git branch name.  Get this by inspecting Gerrit's
-"download" links at the top right.  The branch name will be something
+review. Most "verify" jobs accept parameters to build code in a
+review submitted to Gerrit. You must specify the change ref spec,
+which is a Git branch name. Get this by inspecting Gerrit's
+"download" links at the top right. The branch name will be something
 like this:
 
-       refs/changes/78/578/2
+    refs/changes/78/578/2
 
 The first number is a mystery to me; the second number is the Gerrit
 change number; the third number is the patch set within the change.