commit	4b211271217b1caac7141d2fb2ea6b30d84c9b70	[log] [tgz]
author	Jessica Wagantall <jwagantall@linuxfoundation.org>	Fri Aug 02 23:57:26 2019 +0000
committer	Gerrit Code Review <gerrit@o-ran-sc.org>	Fri Aug 02 23:57:26 2019 +0000
tree	5c28c4ec146e43241e5d3d8ad4cb068a920d1f95
parent	efd8522cdfc154f66c34103b7c3183fa02c36bcd [diff]
parent	868ab36421fe3136a83beddb1ef98b4e489fd9e9 [diff]

tree: 5c28c4ec146e43241e5d3d8ad4cb068a920d1f95

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.