7 name: lf-fetch-dependent-patches
9 - shell: !include-raw: ../shell/gerrit-fetch-dependencies.sh
11 properties-file: $WORKSPACE/.dependency.properties
14 name: lf-license-check
18 FILE_PATTERNS={file-patterns}
19 SPDX_DISABLE={spdx-disable}
20 LHC_VERSION={lhc-version}
21 LICENSE_EXCLUDE_PATHS={license-exclude-paths}
22 LICENSES_ALLOWED={licenses-allowed}
23 - shell: !include-raw-escape:
24 - ../shell/license-check.sh
27 name: lf-infra-create-netrc
30 properties-content: 'SERVER_ID={server-id}'
31 - shell: !include-raw-escape: ../shell/create-netrc.sh
34 name: lf-infra-docker-login
36 - lf-provide-maven-settings:
37 global-settings-file: '{global-settings-file}'
38 settings-file: '{settings-file}'
39 - shell: !include-raw-escape: ../shell/docker-login.sh
40 - lf-provide-maven-settings-cleanup
43 name: lf-infra-gpg-verify-git-signature
44 # TODO: Verify signature after downloading users public key from a locally
45 # created repository instead of the public keymesh. This requires a process
46 # in place to get ODL developers public keys into a local repository without
47 # increasing the job thoughput.
49 - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
52 name: lf-infra-pre-build
54 - shell: !include-raw-escape: ../shell/python-tools-install.sh
57 name: lf-infra-ship-logs
59 # Ensure no pre-existing .netrc files are overriding logs config
60 - lf-provide-maven-settings-cleanup
61 - config-file-provider:
63 - file-id: 'jenkins-log-archives-settings'
64 variable: 'SETTINGS_FILE'
65 - lf-infra-create-netrc:
67 - shell: !include-raw:
68 # Ensure python-tools are installed in case job template does not
69 # call the lf-infra-pre-build macro.
70 - ../shell/python-tools-install.sh
71 - ../shell/logs-deploy.sh
72 - shell: !include-raw:
73 - ../shell/logs-clear-credentials.sh
75 regexp: '^Build logs: .*'
78 name: lf-infra-package-listing
80 - shell: !include-raw:
81 - ../shell/package-listing.sh
84 name: lf-infra-packer-build
87 condition-kind: boolean-expression
88 condition-expression: '{openstack}'
90 - config-file-provider:
92 - file-id: clouds-yaml
93 target: '$HOME/.config/openstack/clouds.yaml'
95 properties-content: OS_CLOUD={openstack-cloud}
96 - config-file-provider:
98 - file-id: '{packer-cloud-settings}'
101 properties-content: |
102 PACKER_PLATFORM={platform}
103 PACKER_TEMPLATE={template}
104 PACKER_VERSION={packer-version}
105 - shell: !include-raw-escape:
106 - ../shell/packer-install.sh
107 - ../shell/packer-build.sh
108 - shell: !include-raw:
109 - ../shell/packer-clear-credentials.sh
112 name: lf-infra-packer-validate
115 condition-kind: boolean-expression
116 condition-expression: '{openstack}'
118 - config-file-provider:
120 - file-id: clouds-yaml
121 target: '$HOME/.config/openstack/clouds.yaml'
123 properties-content: OS_CLOUD={openstack-cloud}
124 - config-file-provider:
126 - file-id: '{packer-cloud-settings}'
129 properties-content: |
130 PACKER_VERSION={packer-version}
131 - shell: !include-raw-escape:
132 - ../shell/packer-install.sh
133 - ../shell/packer-validate.sh
134 - shell: !include-raw:
135 - ../shell/packer-clear-credentials.sh
138 name: lf-infra-push-gerrit-patch
141 properties-content: |
143 GERRIT_COMMIT_MESSAGE={gerrit-commit-message}
144 GERRIT_HOST={gerrit-host}
145 GERRIT_TOPIC={gerrit-topic}
146 GERRIT_USER={gerrit-user}
147 REVIEWERS_EMAIL={reviewers-email}
148 - shell: !include-raw-escape: ../shell/gerrit-push-patch.sh
151 name: lf-infra-sysstat
153 - shell: !include-raw:
154 - ../shell/sysstat.sh
157 name: lf-jacoco-nojava-workaround
159 - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
162 name: lf-infra-deploy-maven-file
165 mvn-version: '{mvn-version}'
166 - lf-provide-maven-settings:
167 global-settings-file: '{global-settings-file}'
168 settings-file: '{settings-file}'
170 properties-content: |
171 MAVEN_REPO_URL={maven-repo-url}
174 UPLOAD_FILES_PATH={upload-files-dir}
175 - shell: !include-raw-escape:
176 - ../shell/common-variables.sh
177 - ../shell/deploy-maven-file.sh
178 - lf-provide-maven-settings-cleanup
181 name: lf-maven-central
184 condition-kind: boolean-expression
185 condition-expression: '{mvn-central}'
187 - lf-provide-maven-settings:
188 global-settings-file: '{mvn-global-settings}'
189 settings-file: '{mvn-settings}'
190 - lf-infra-create-netrc:
193 properties-content: 'OSSRH_PROFILE_ID={ossrh-profile-id}'
194 - shell: !include-raw-escape: ../shell/maven-central.sh
195 - lf-provide-maven-settings-cleanup
198 name: lf-maven-install
200 # Create a $HOME/.wgetrc to make the Maven download quiet.
201 - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
203 maven-version: '{mvn-version}'
205 - shell: 'rm "$HOME/.wgetrc"'
208 name: lf-provide-maven-settings
210 - config-file-provider:
212 - file-id: '{global-settings-file}'
213 variable: 'GLOBAL_SETTINGS_FILE'
214 - file-id: '{settings-file}'
215 variable: 'SETTINGS_FILE'
221 properties-content: PIP_PACKAGES={pip-packages}
222 - shell: !include-raw-escape: ../shell/pip-install.sh
225 name: lf-provide-maven-settings-cleanup
229 set +e # DO NOT cause build failure if any of the rm calls fail.
231 rm -f "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
233 # In some cases we use the lf-provide-maven-settings macro to produce
234 # a "$HOME/.netrc" file containing credentials. Remove that file here
238 # DO NOT fail build if any of the above lines fail.
242 name: lf-rtd-trigger-build
245 properties-content: |
246 RTD_BUILD_URL={rtd-build-url}
247 RTD_TOKEN={rtd-token}
248 - shell: !include-raw-escape: ../shell/rtd-trigger-build.sh
254 properties-content: DOC_DIR={doc-dir}
255 - shell: !include-raw-escape: ../shell/tox-install.sh
256 - shell: !include-raw-escape: ../shell/rtd-verify.sh
259 name: lf-sigul-sign-dir
260 # Requires that Jenkins be configured with SIGUL_BRIDGE_IP as a global
261 # Environment variable
264 condition-kind: boolean-expression
265 condition-expression: '{sign-artifacts}'
267 - config-file-provider:
269 - file-id: sigul-config
270 variable: SIGUL_CONFIG
271 - file-id: sigul-password
272 variable: SIGUL_PASSWORD
275 - shell: !include-raw-escape: ../shell/sigul-configuration.sh
276 - shell: !include-raw-escape: ../shell/sigul-install.sh
278 properties-content: SIGN_DIR={sign-dir}
279 - shell: !include-raw-escape:
280 - ../shell/common-variables.sh
281 - ../shell/sigul-sign-dir.sh
282 - shell: !include-raw-escape: ../shell/sigul-configuration-cleanup.sh
285 name: lf-infra-provide-docker-cleanup
289 set +e # DO NOT cause build failure if docker rmi fails
290 docker rmi -f $(docker images -a -q)
299 name: lf-clm-parameters
303 default: '{nexus-iq-stage}'
305 Stage the policy evaluation will be run against on the Nexus IQ Server.
308 name: lf-cmake-parameters
309 # Parameters useful in CMake builds.
313 default: '{build-dir}'
314 description: 'Directory to build the project in.'
317 default: '{cmake-opts}'
319 Options to pass to CMAKE.
320 Example: -DCMAKE_INSTALL_PREFIX=$WORKSPACE/target/output
323 default: '{install-prefix}'
324 description: 'Install prefix for C/C++ builds. Example: /usr/local'
327 default: '{make-opts}'
328 description: 'Options to pass to make. Example: -j8'
331 name: lf-infra-maven-parameters
335 # Sets an env var for shell scripts to be able to call the dynamically
336 # installed maven without having to calculate the M2_HOME themselves.
337 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}'
338 description: 'Maven selector to be used by shell scripts'
341 default: '{mvn-opts}'
343 Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
346 default: '{mvn-params}'
348 Maven parameters to pass to the mvn command.
351 # Sets an env var for shell scripts to be able to call the dynamically
352 # installed maven without having to calculate the path themselves.
353 # yamllint disable-line rule:line-length
354 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
355 description: 'Maven selector to be used by shell scripts'
358 name: lf-infra-openstack-parameters
362 default: '{os-cloud}'
364 The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
365 variable name that is significant to openstack client as a
366 environment variable. Please refer to the documentation for
368 https://docs.openstack.org/developer/python-openstackclient/
372 name: lf-infra-parameters
373 # Standard parameters used in the LF CI environments. Gerrit variables are
374 # not used by GitHub projects, but defining them isn't harmful.
380 Parameter to identify a SCM project to build. This is typically
381 the project repo path. For example: ofextensions/circuitsw
386 Stream is often set to the same name as 'branch' but can
387 sometimes be used as a name representing a project's release code
393 Gerrit Trigger provided parameter to identify Gerrit project that
394 triggered the build. This is typically the project repo path as
395 exists in Gerrit. For example: ofextensions/circuitsw
397 If using Gerrit, in a manual build this should match the PROJECT
403 Gerrit Trigger provided parameter to identify a Gerrit branch.
405 If using Gerrit, in a manual build override with the branch to
409 default: 'refs/heads/{branch}'
411 Gerrit Trigger provided parameter to identify a refspec to fetch
414 If using Gerrit, in a manual build override with a refspec.
415 https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
416 For example: 'refs/heads/master'
419 default: 'origin/{branch}'
421 GitHub PR Trigger provided parameter for specifying the commit
424 If using GitHub, in a manual build override with a branch path or
425 sha1 hash to a specific commit. For example: 'origin/master'
428 name: lf-infra-node-parameters
432 default: '{node-dir}'
433 description: Path to a Node project directory.
436 default: '{node-version}'
437 description: Version of NodeJS to install.
440 name: lf-infra-tox-parameters
446 Path to directory containing tox.ini file.
449 default: '{tox-envs}'
451 Tox environments to run build against.
452 Example: docs,py2,py3
459 name: lf-infra-properties
462 # Allow build data to be stored at a length configured by the
463 # downstream project.
464 days-to-keep: '{build-days-to-keep}'
465 # Do not allow artifacts to be stored in Jenkins.
466 artifact-num-to-keep: 0
473 name: lf-jacoco-report
476 exec-pattern: "**/**.exec"
477 class-pattern: "**/classes"
478 source-pattern: "**/src/main/java"
479 # yamllint disable-line rule:line-length
480 exclusion-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
491 name: lf-infra-publish
492 # lf-infra macro to finish up a build.
494 # Handles the following:
495 # - Shipping logs to Nexus logs site repository
496 # - Cleanup workspace
509 - lf-infra-package-listing
511 mark-unstable-if-failed: true
514 # Do not clean up *.jenkins-trigger files for jobs that use a
515 # properties file as input for triggering another build.
516 - '**/*.jenkins-trigger'
520 name: lf-infra-publish-windows
521 # lf-infra macro to finish up a build.
523 # Handles the following:
524 # - Shipping logs to Nexus logs site repository
525 # - Cleanup workspace
527 # TODO: RELENG-1228 Develop log shipping script for Windows systems
538 # - lf-infra-ship-logs-windows
539 # mark-unstable-if-failed: true
542 # Do not clean up *.jenkins-trigger files for jobs that use a
543 # properties file as input for triggering another build.
544 - '**/*.jenkins-trigger'
552 name: lf-infra-gerrit-scm
555 credentials-id: '{jenkins-ssh-credential}'
559 - 'refs/heads/{branch}'
563 recursive: '{submodule-recursive}'
564 timeout: '{submodule-timeout}'
565 choosing-strategy: '{choosing-strategy}'
568 name: lf-infra-github-scm
571 credentials-id: '{jenkins-ssh-credential}'
579 recursive: '{submodule-recursive}'
580 timeout: '{submodule-timeout}'
581 choosing-strategy: '{choosing-strategy}'
588 name: lf-infra-wrappers-common
593 timeout: '{build-timeout}'
594 timeout-var: 'BUILD_TIMEOUT'
601 name: lf-infra-wrappers
603 - lf-infra-wrappers-common:
604 build-timeout: '{build-timeout}'
605 - config-file-provider:
608 target: '$HOME/.npmrc'
610 target: '$HOME/.config/pip/pip.conf'
611 - ssh-agent-credentials:
613 - '{jenkins-ssh-credential}'
616 name: lf-infra-wrappers-windows
618 - lf-infra-wrappers-common:
619 build-timeout: '{build-timeout}'