6 # To take advantage of this macro, have your build write
7 # out the file 'gerrit_comment.txt' with information to post
8 # back to gerrit and include this macro in the list of builders.
10 name: comment-to-gerrit
12 - shell: !include-raw: ../shell/comment-to-gerrit.sh
15 name: lf-fetch-dependent-patches
17 - shell: !include-raw: ../shell/gerrit-fetch-dependencies.sh
19 properties-file: $WORKSPACE/.dependency.properties
22 name: lf-license-check
26 FILE_PATTERNS={file-patterns}
27 SPDX_DISABLE={spdx-disable}
28 LHC_VERSION={lhc-version}
29 LICENSE_EXCLUDE_PATHS={license-exclude-paths}
30 LICENSES_ALLOWED={licenses-allowed}
31 - shell: !include-raw-escape:
32 - ../shell/license-check.sh
35 name: lf-infra-create-netrc
38 properties-content: "SERVER_ID={server-id}"
39 - shell: !include-raw-escape: ../shell/create-netrc.sh
42 name: lf-infra-docker-login
44 - lf-provide-maven-settings:
45 global-settings-file: "{global-settings-file}"
46 settings-file: "{settings-file}"
47 - shell: !include-raw-escape: ../shell/docker-login.sh
48 - lf-provide-maven-settings-cleanup
51 name: lf-infra-gpg-verify-git-signature
52 # TODO: Verify signature after downloading users public key from a locally
53 # created repository instead of the public keymesh. This requires a process
54 # in place to get ODL developers public keys into a local repository without
55 # increasing the job thoughput.
57 - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
60 name: lf-infra-pre-build
62 - shell: !include-raw-escape: ../shell/python-tools-install.sh
65 name: lf-infra-ship-logs
67 # Ensure no pre-existing .netrc files are overriding logs config
68 - lf-provide-maven-settings-cleanup
69 - config-file-provider:
71 - file-id: "jenkins-log-archives-settings"
72 variable: "SETTINGS_FILE"
73 - lf-infra-create-netrc:
75 - shell: !include-raw:
76 # Ensure python-tools are installed in case job template does not
77 # call the lf-infra-pre-build macro.
78 - ../shell/python-tools-install.sh
79 - shell: !include-raw:
80 - ../shell/logs-deploy.sh
81 - shell: !include-raw:
82 - ../shell/logs-clear-credentials.sh
84 regexp: "^Build logs: .*"
87 name: lf-infra-package-listing
89 - shell: !include-raw:
90 - ../shell/package-listing.sh
93 name: lf-infra-packer-build
96 condition-kind: boolean-expression
97 condition-expression: "{openstack}"
99 - config-file-provider:
101 - file-id: clouds-yaml
102 target: "$HOME/.config/openstack/clouds.yaml"
104 properties-content: OS_CLOUD={openstack-cloud}
105 - config-file-provider:
107 - file-id: "{packer-cloud-settings}"
110 properties-content: |
111 PACKER_PLATFORM={platform}
112 PACKER_TEMPLATE={template}
113 PACKER_VERSION={packer-version}
114 - shell: !include-raw-escape:
115 - ../shell/packer-install.sh
116 - ../shell/packer-build.sh
117 - shell: !include-raw:
118 - ../shell/packer-clear-credentials.sh
121 name: lf-infra-packer-validate
124 condition-kind: boolean-expression
125 condition-expression: "{openstack}"
127 - config-file-provider:
129 - file-id: clouds-yaml
130 target: "$HOME/.config/openstack/clouds.yaml"
132 properties-content: OS_CLOUD={openstack-cloud}
133 - config-file-provider:
135 - file-id: "{packer-cloud-settings}"
138 properties-content: |
139 PACKER_VERSION={packer-version}
140 - shell: !include-raw-escape:
141 - ../shell/packer-install.sh
142 - ../shell/packer-validate.sh
143 - shell: !include-raw:
144 - ../shell/packer-clear-credentials.sh
147 name: lf-infra-push-gerrit-patch
150 properties-content: |
152 GERRIT_COMMIT_MESSAGE={gerrit-commit-message}
153 GERRIT_HOST={gerrit-host}
154 GERRIT_TOPIC={gerrit-topic}
155 GERRIT_USER={gerrit-user}
156 REVIEWERS_EMAIL={reviewers-email}
157 - shell: !include-raw-escape: ../shell/gerrit-push-patch.sh
160 name: lf-infra-sysstat
162 - shell: !include-raw:
163 - ../shell/sysstat.sh
166 name: lf-jacoco-nojava-workaround
168 - shell: "mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes"
171 name: lf-infra-deploy-maven-file
174 mvn-version: "{mvn-version}"
175 - lf-provide-maven-settings:
176 global-settings-file: "{global-settings-file}"
177 settings-file: "{settings-file}"
179 properties-content: |
180 MAVEN_REPO_URL={maven-repo-url}
183 UPLOAD_FILES_PATH={upload-files-dir}
184 - shell: !include-raw-escape:
185 - ../shell/common-variables.sh
186 - ../shell/deploy-maven-file.sh
187 - lf-provide-maven-settings-cleanup
190 name: lf-maven-central
193 condition-kind: boolean-expression
194 condition-expression: "{mvn-central}"
196 - lf-provide-maven-settings:
197 global-settings-file: "{mvn-global-settings}"
198 settings-file: "{mvn-settings}"
199 - lf-infra-create-netrc:
202 properties-content: "OSSRH_PROFILE_ID={ossrh-profile-id}"
203 - shell: !include-raw-escape: ../shell/maven-central.sh
204 - lf-provide-maven-settings-cleanup
207 name: lf-maven-install
209 # Create a $HOME/.wgetrc to make the Maven download quiet.
210 - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
212 maven-version: "{mvn-version}"
214 - shell: 'rm "$HOME/.wgetrc"'
217 name: lf-provide-maven-settings
219 - config-file-provider:
221 - file-id: "{global-settings-file}"
222 variable: "GLOBAL_SETTINGS_FILE"
223 - file-id: "{settings-file}"
224 variable: "SETTINGS_FILE"
230 properties-content: PIP_PACKAGES={pip-packages}
231 - shell: !include-raw-escape: ../shell/pip-install.sh
234 name: lf-provide-maven-settings-cleanup
238 set +e # DO NOT cause build failure if any of the rm calls fail.
240 rm -f "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
242 # In some cases we use the lf-provide-maven-settings macro to produce
243 # a "$HOME/.netrc" file containing credentials. Remove that file here
247 # DO NOT fail build if any of the above lines fail.
251 name: lf-rtd-trigger-build
254 properties-content: |
255 RTD_BUILD_URL={rtd-build-url}
256 RTD_TOKEN={rtd-token}
257 - shell: !include-raw-escape: ../shell/rtd-trigger-build.sh
263 properties-content: DOC_DIR={doc-dir}
264 - shell: !include-raw-escape: ../shell/tox-install.sh
265 - shell: !include-raw-escape: ../shell/rtd-verify.sh
268 name: check-info-votes
271 properties-content: JENKINS_SSH_CREDENTIAL={jenkins-ssh-credential}
272 - shell: !include-raw-escape: ../shell/check-info-votes.sh
277 - config-file-provider:
279 - file-id: lftoolsini
280 target: "$HOME/.config/lftools/lftools.ini"
281 - shell: !include-raw: ../shell/release-job.sh
284 name: lf-sigul-sign-dir
285 # Requires that Jenkins be configured with SIGUL_BRIDGE_IP as a global
286 # Environment variable
289 condition-kind: boolean-expression
290 condition-expression: "{sign-artifacts}"
292 - config-file-provider:
294 - file-id: sigul-config
295 variable: SIGUL_CONFIG
296 - file-id: sigul-password
297 variable: SIGUL_PASSWORD
300 - shell: !include-raw-escape: ../shell/sigul-configuration.sh
301 - shell: !include-raw-escape: ../shell/sigul-install.sh
303 properties-content: |
305 SIGN_MODE={sign-mode}
306 - shell: !include-raw-escape:
307 - ../shell/sigul-sign-dir.sh
308 - shell: !include-raw-escape: ../shell/sigul-configuration-cleanup.sh
311 name: lf-infra-provide-docker-cleanup
315 set +e # DO NOT cause build failure if docker rmi fails
316 docker rmi -f $(docker images -a -q)
321 # Run a Sonar Jenkins Plugin
325 scanner-name: SonarQubeScanner
327 project: "sonar-project.properties"
328 properties: "{sonar-properties}"
329 java-opts: "{sonar-java-opts}"
330 additional-arguments: "{sonar-additional-args}"
333 name: lf-infra-sonar-with-prescan
334 # Run a Sonar Jenkins Plugin
336 - lf-sonar-prescan # Must be defined by caller
339 scanner-name: SonarQubeScanner
341 project: "sonar-project.properties"
342 properties: "{sonar-properties}"
343 java-opts: "{sonar-java-opts}"
344 additional-arguments: "{sonar-additional-args}"
351 name: lf-clm-parameters
355 default: "{nexus-iq-stage}"
357 Stage the policy evaluation will be run against on the Nexus IQ Server.
360 name: lf-cmake-parameters
361 # Parameters useful in CMake builds.
365 default: "{build-dir}"
366 description: "Directory to build the project in."
369 default: "{cmake-opts}"
371 Options to pass to CMAKE.
372 Example: -DCMAKE_INSTALL_PREFIX=$WORKSPACE/target/output
375 default: "{install-prefix}"
376 description: "Install prefix for C/C++ builds. Example: /usr/local"
379 default: "{make-opts}"
380 description: "Options to pass to make. Example: -j8"
383 name: lf-infra-maven-parameters
387 # Sets an env var for shell scripts to be able to call the dynamically
388 # installed maven without having to calculate the M2_HOME themselves.
389 default: "/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}"
390 description: "Maven selector to be used by shell scripts"
393 default: "{mvn-opts}"
395 Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
398 default: "{mvn-params}"
400 Maven parameters to pass to the mvn command.
403 # Sets an env var for shell scripts to be able to call the dynamically
404 # installed maven without having to calculate the path themselves.
405 # yamllint disable-line rule:line-length
406 default: "/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn"
407 description: "Maven selector to be used by shell scripts"
410 name: lf-infra-openstack-parameters
414 default: "{os-cloud}"
416 The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
417 variable name that is significant to openstack client as a
418 environment variable. Please refer to the documentation for
420 https://docs.openstack.org/developer/python-openstackclient/
423 name: lf-infra-parameters
424 # Standard parameters used in the LF CI environments. Gerrit variables are
425 # not used by GitHub projects, but defining them isn't harmful.
431 Parameter to identify a SCM project to build. This is typically
432 the project repo path. For example: ofextensions/circuitsw
437 Stream is often set to the same name as 'branch' but can
438 sometimes be used as a name representing a project's release code
444 Gerrit Trigger provided parameter to identify Gerrit project that
445 triggered the build. This is typically the project repo path as
446 exists in Gerrit. For example: ofextensions/circuitsw
448 If using Gerrit, in a manual build this should match the PROJECT
454 Gerrit Trigger provided parameter to identify a Gerrit branch.
456 If using Gerrit, in a manual build override with the branch to
460 default: "refs/heads/{branch}"
462 Gerrit Trigger provided parameter to identify a refspec to fetch
465 If using Gerrit, in a manual build override with a refspec.
466 https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
467 For example: 'refs/heads/master'
470 default: "origin/{branch}"
472 GitHub PR Trigger provided parameter for specifying the commit
475 If using GitHub, in a manual build override with a branch path or
476 sha1 hash to a specific commit. For example: 'origin/master'
479 name: lf-infra-node-parameters
483 default: "{node-dir}"
484 description: Path to a Node project directory.
487 default: "{node-version}"
488 description: Version of NodeJS to install.
491 name: lf-infra-tox-parameters
497 Path to directory containing tox.ini file.
500 default: "{tox-envs}"
502 Tox environments to run build against.
503 Example: docs,py2,py3
506 name: lf-build-with-parameters-maven-release
511 description: "This is the tag, Example: 1.0.0"
515 description: "Log dir, example: project-maven-stage-master/17/"
517 name: DISTRIBUTION_TYPE
519 description: "Set to maven for build with parametes"
521 name: USE_RELEASE_FILE
522 default: "{use-release-file}"
523 description: "Set to False for job built with parameters"
530 name: lf-infra-properties
533 # Allow build data to be stored at a length configured by the
534 # downstream project.
535 days-to-keep: "{build-days-to-keep}"
536 # Do not allow artifacts to be stored in Jenkins.
537 artifact-num-to-keep: 0
544 name: lf-jacoco-report
547 exec-pattern: "**/**.exec"
548 class-pattern: "**/classes"
549 source-pattern: "**/src/main/java"
550 # yamllint disable-line rule:line-length
551 exclusion-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
562 name: lf-infra-publish
563 # lf-infra macro to finish up a build.
565 # Handles the following:
566 # - Shipping logs to Nexus logs site repository
567 # - Cleanup workspace
580 - lf-infra-package-listing
582 mark-unstable-if-failed: true
585 # Do not clean up *.jenkins-trigger files for jobs that use a
586 # properties file as input for triggering another build.
587 - "**/*.jenkins-trigger"
591 name: lf-infra-publish-windows
592 # lf-infra macro to finish up a build.
594 # Handles the following:
595 # - Shipping logs to Nexus logs site repository
596 # - Cleanup workspace
598 # TODO: RELENG-1228 Develop log shipping script for Windows systems
609 # - lf-infra-ship-logs-windows
610 # mark-unstable-if-failed: true
613 # Do not clean up *.jenkins-trigger files for jobs that use a
614 # properties file as input for triggering another build.
615 - "**/*.jenkins-trigger"
623 name: lf-infra-gerrit-scm
626 credentials-id: "{jenkins-ssh-credential}"
630 - "refs/heads/{branch}"
634 disable: "{submodule-disable}"
635 recursive: "{submodule-recursive}"
636 timeout: "{submodule-timeout}"
637 choosing-strategy: "{choosing-strategy}"
640 name: lf-infra-github-scm
643 credentials-id: "{jenkins-ssh-credential}"
651 disable: "{submodule-disable}"
652 recursive: "{submodule-recursive}"
653 timeout: "{submodule-timeout}"
654 choosing-strategy: "{choosing-strategy}"
661 name: lf-infra-wrappers-common
666 timeout: "{build-timeout}"
667 timeout-var: "BUILD_TIMEOUT"
674 name: lf-infra-wrappers
676 - lf-infra-wrappers-common:
677 build-timeout: "{build-timeout}"
678 - config-file-provider:
681 target: "$HOME/.npmrc"
683 target: "$HOME/.config/pip/pip.conf"
684 - ssh-agent-credentials:
686 - "{jenkins-ssh-credential}"
689 name: lf-infra-wrappers-windows
691 - lf-infra-wrappers-common:
692 build-timeout: "{build-timeout}"