commit	9f49620a9e28da94081e521b5b8d0251edccaba6	[log] [tgz]
author	Andrew Grimberg <agrimberg@linuxfoundation.org>	Tue May 14 11:25:36 2019 -0700
committer	Andrew Grimberg <agrimberg@linuxfoundation.org>	Tue May 14 11:25:36 2019 -0700
tree	cdce6af1cc116b4f767054e248de48d2dd711f55
parent	e7bb7faadaf49fe0bcefadd1e383c0799023e651 [diff]

tree: cdce6af1cc116b4f767054e248de48d2dd711f55

README.md

Continuous Integration for O-RAN SC at LF

This repo contains configuration files for Jenkins jobs for the O-RAN SC project.

Custom JJB templates for Docker Java projects

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::

jobs:
  - gerrit-maven-docker-verify
  - gerrit-maven-docker-merge
  - gerrit-maven-docker-stage

Testing the templates

These instructions explain how to test the templates using the Jenkins sandbox. This catches errors before submitting the changes as Gerrit reviews.

Prerequisites

Install the Jenkins job builder:

pip install jenkins-job-builder

Check out the global JJB templates submodule within this repo:

git submodule update --init

Test Locally

Check sanity by running the Jenkins job-builder script in this directory:

jenkins-jobs test -r jjb

Deploy the templates to 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

Create a config file jenkins.ini using the following template and your credentials (user name and API token from above)::

[job_builder]
ignore_cache=True
keep_descriptions=False
recursive=True

[jenkins]
query_plugins_info=False
url=https://jenkins.o-ran-sc.org/sandbox
user=YOUR-USER-NAME
password=YOUR-API-TOKEN

Build and deploy a specific job using the EXACT job name.

jenkins-jobs --conf jenkins.ini update jjb your-job-name-here

Examples:

jenkins-jobs --conf jenkins.ini update jjb project-maven-docker-verify-master-mvn33-openjdk8

In the sandbox visit the job page, then click the button "Build with 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 like this:

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.

Enter this name for both the GERRIT_BRANCH and the GERRIT_REFSPEC parameters, then click Build.