7 name: lf-infra-create-netrc
8 # Macro to create a ~/.netrc file from a Maven settings.xml
10 # {server-id} The id of a server as defined in settings.xml
13 properties-content: 'SERVER_ID={server-id}'
14 - shell: !include-raw-escape: ../shell/create-netrc.sh
17 name: lf-infra-docker-login
18 # Login into a custom hosted docker registry and / or docker.io
20 # The Jenkins system should have the following global variables defined
22 # DOCKER_REGISTRY : Optional
23 # The DNS address of the registry (IP or FQDN)
24 # ex: nexus3.example.com
26 # REGISTRY_PORTS : Required if DOCKER_REGISTRY is set
27 # Space separated listing of the registry ports to login
29 # ex: 10001 10002 10003 10004
31 # DOCKERHUB_EMAIL : Optional
32 # If this variable is set then an attempt to login to
33 # DockerHub (docker.io) will be also made. It should be
34 # set to the email address for the credentials that will
35 # get looked up. Only _one_ credential will ever be found
36 # in the maven settings file for DockerHub
38 - lf-provide-maven-settings:
39 global-settings-file: '{global-settings-file}'
40 settings-file: '{settings-file}'
41 - shell: !include-raw-escape: ../shell/docker-login.sh
42 - lf-provide-maven-settings-cleanup
45 name: lf-infra-gpg-verify-git-signature
46 # Verify gpg signature of the latest commit message in $WORKSPACE
48 # This command assumes that $WORKSPACE is a git repo.
50 # TODO: Verify signature after downloading users public key from a locally
51 # created repository instead of the public keymesh. This requires a process
52 # in place to get ODL developers public keys into a local repository without
53 # increasing the job thoughput.
55 - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
58 name: lf-infra-ship-logs
60 - config-file-provider:
62 - file-id: 'jenkins-log-archives-settings'
63 variable: 'SETTINGS_FILE'
64 - lf-infra-create-netrc:
66 - shell: !include-raw:
67 - ../shell/lftools-install.sh
68 - ../shell/logs-deploy.sh
69 - shell: !include-raw:
70 - ../shell/logs-clear-credentials.sh
72 regexp: '^Build logs: .*'
75 name: lf-infra-sysstat
77 - shell: !include-raw:
81 name: lf-jacoco-nojava-workaround
83 - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
86 name: lf-infra-deploy-maven-file
87 # Deploy files to a repository.
89 # The builder requires passing the following parameters
90 # REPO_ID: Repository ID
91 # GROUP_ID: Group ID of the repository
92 # UPLOAD_FILES_PATH: Path to directory containing one or more files
95 mvn-version: '{mvn-version}'
96 - lf-provide-maven-settings:
97 global-settings-file: '{global-settings-file}'
98 settings-file: '{settings-file}'
100 properties-content: |
103 UPLOAD_FILES_PATH={files-dir}
104 - shell: !include-raw-escape:
105 - ../shell/lftools-install.sh
106 - ../shell/deploy-maven-file.sh
107 - lf-provide-maven-settings-cleanup
110 name: lf-maven-install
111 # call maven-target builder with a goal of --version to force Jenkins to
112 # install the needed maven version
114 # Create a $HOME/.wgetrc to make the Maven download quiet.
115 - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
117 maven-version: '{mvn-version}'
119 - shell: 'rm "$HOME/.wgetrc"'
122 name: lf-provide-maven-settings
123 # Push a global settings and user settings maven files
125 - config-file-provider:
127 - file-id: '{global-settings-file}'
128 variable: 'GLOBAL_SETTINGS_FILE'
129 - file-id: '{settings-file}'
130 variable: 'SETTINGS_FILE'
133 name: lf-provide-maven-settings-cleanup
134 # Clear maven settings files after we are done using them
138 set +e # DO NOT cause build failure if any of the rm calls fail.
140 rm "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
142 # In some cases we use the lf-provide-maven-settings macro to produce
143 # a "$HOME/.netrc" file containing credentials. Remove that file here
147 # DO NOT fail build if any of the above lines fail.
155 name: lf-infra-parameters
156 # Standard parameters used in the LF CI environments. Gerrit variables are
157 # not used by GitHub projects, but defining them isn't harmful.
163 Parameter to identify a Gerrit project. This is typically the
164 project repo path as exists in Gerrit.
165 For example: ofextensions/circuitsw
170 Stream is often set to the same name as 'branch' but can
171 sometimes be used as a name representing a project's release code
177 Parameter to identify Gerrit project. This is typically the
178 project repo path as exists in Gerrit.
179 For example: ofextensions/circuitsw
181 Note that Gerrit will override this parameter automatically if a
182 job is triggered by Gerrit.
187 Parameter to identify a Gerrit branch.
189 Note that Gerrit will override this parameter automatically if a
190 job is triggered by Gerrit.
195 Parameter to identify a refspec when pulling from Gerrit.
197 Note that Gerrit will override this parameter automatically if a
198 job is triggered by Gerrit.
201 name: lf-infra-maven-parameters
205 default: '{mvn-opts}'
207 Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
210 default: '{mvn-params}'
212 Maven parameters to pass to the mvn command.
215 # Sets an env var for shell scripts to be able to call the dynamically
216 # installed maven without having to calculate the path themselves.
217 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
218 description: 'Maven selector to be used by shell scripts'
220 name: STAGING_PROFILE_ID
221 default: '{staging-profile-id}'
223 Nexus staging profile ID.
226 name: lf-infra-tox-parameters
227 # Useful parameters when working with TOX
228 # https://tox.readthedocs.io/
234 Path to directory containing tox.ini file.
237 default: '{tox-envs}'
239 Tox environments to run build against.
240 Example: docs,py2,py3
247 name: lf-infra-properties
250 # Allow build data to be stored at a length configured by the
251 # downstream project.
252 days-to-keep: '{build-days-to-keep}'
253 # Do not allow artifacts to be stored in Jenkins.
254 artifact-num-to-keep: 0
261 name: lf-infra-publish
262 # lf-infra macro to finish up a build.
264 # Handles the following:
265 # - Shipping logs to Nexus logs site repository
266 # - Cleanup workspace
272 script-only-if-succeeded: false
273 script-only-if-failed: false
274 mark-unstable-if-failed: false
277 # Do not clean up *.jenkins-trigger files for jobs that use a
278 # properties file as input for triggering another build.
279 - '**/*.jenkins-trigger'
287 name: lf-infra-gerrit-scm
290 credentials-id: '{jenkins-ssh-credential}'
294 - 'refs/heads/{branch}'
298 recursive: '{submodule-recursive}'
299 choosing-strategy: '{choosing-strategy}'
302 name: lf-infra-github-scm
305 credentials-id: '{jenkins-ssh-credential}'
311 recursive: '{submodule-recursive}'
312 choosing-strategy: '{choosing-strategy}'
319 name: lf-infra-github-pr-trigger
321 - github-pull-request:
322 trigger-phrase: '{trigger-phrase}'
323 only-trigger-phrase: '{only-trigger-phrase}'
324 status-context: '{status-context}'
325 permit-all: '{permit-all}'
326 github-hooks: '{github-hooks}'
327 auto-close-on-fail: false
330 white-list: '{obj:github_pr_whitelist}'
331 admin-list: '{obj:github_pr_admin_list}'
338 name: lf-infra-wrappers
343 timeout: '{build-timeout}'
344 timeout-var: 'BUILD_TIMEOUT'
347 - ssh-agent-credentials:
349 - '{jenkins-ssh-credential}'