11 This macro will post a comment to the gerrit patchset if the build
12 creates a file named gerrit_comment.txt
13 To use this macro add it to the list of builders.
16 lf-fetch-dependent-patches
17 --------------------------
19 Fetch all patches provided via comment trigger
21 This macro will fetch all patches provided via comment trigger and will
22 create a list of projects from those patches via environment variable
23 called DEPENDENCY_BUILD_ORDER which can be used if necessary to build
24 projects in the specified order. The order is determined by first patch
25 instance for a project in the patch list.
34 :file-patterns: Space-separated list of file patterns to scan.
35 For example: \*.go \*.groovy \*.java \*.py \*.sh
36 :spdx-disable: Disable the SPDX-Identifier checker.
37 :lhc-version: Version of LHC to use.
38 :license-exclude-paths: Comma-separated list of paths to exclude from the
39 license checker. The paths used here will be matched using a contains
40 rule so it is best to be as precise with the path as possible.
41 For example a path of '/src/generated/' will be searched as
42 '**/src/generated/**'.
43 Example: org/opendaylight/yang/gen,protobuff/messages
44 :licenses-allowed: Comma-separated list of allowed licenses.
45 For example: Apache-2.0,EPL-1.0,MIT
50 Create a ~/.netrc file from a Maven settings.xml
54 :server-id: The id of a server as defined in settings.xml.
58 :ALT_NEXUS_SERVER: URL of custom nexus server.
59 If set this will take precedence.
60 Use this to point at nexus3.$PROJECTDOMAIN
63 lf-infra-deploy-maven-file
64 --------------------------
66 Deploy files to a repository.
70 :global-settings-file: Global settings file to use.
71 :group-id: Group ID of the repository.
72 :maven-repo-url: URL of a Maven repository to upload to.
73 :mvn-version: Version of Maven to use.
74 :repo-id: Repository ID
75 :settings-file: Maven settings file to use.
76 :upload-files-dir: Path to directory containing one or more files
81 Login into a custom hosted docker registry and / or docker.io
83 The Jenkins system should have the following global variables defined
85 :Environment variables:
87 :DOCKER_REGISTRY: The DNS address of the registry (IP or FQDN)
88 ex: nexus3.example.com (GLOBAL variable)
90 :REGISTRY_PORTS: Required if DOCKER_REGISTRY is set. Space separated list
91 of the registry ports to login to. ex: 10001 10002 10003 10004
94 :DOCKERHUB_EMAIL: If this variable is set then an attempt to login to
95 DockerHub (docker.io) will be also made. It should be set to the email
96 address for the credentials that will get looked up. Only _one_
97 credential will ever be found in the maven settings file for DockerHub.
100 lf-infra-gpg-verify-git-signature
101 ---------------------------------
103 Verify gpg signature of the latest commit message in $WORKSPACE.
104 This command assumes that $WORKSPACE is a git repo.
109 Macro that runs before all builders to prepare the system for job use.
111 lf-infra-package-listing
112 ------------------------
114 Lists distro level packages.
116 lf-infra-packer-build
117 ---------------------
119 Run `packer build` to build system images.
121 :Required parameters:
123 :openstack: Packer template uses an OpenStack builder (true|false).
124 :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
125 :packer-version: Version of packer to use.
126 :platform: Build platform as found in the vars directory.
127 :template: Packer template to build as found in the templates directory.
129 :Optional parameters:
131 :update-cloud-image: Submit a change request to update new built cloud
134 lf-infra-packer-validate
135 ------------------------
137 Run `packer validate` to verify packer configuration.
139 :Required parameters:
141 :openstack: Packer template uses an OpenStack builder (true|false).
142 :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
143 :packer-cloud-settings: Cloud configuration file. Loaded on the build
144 server as CLOUDENV environment variable.
145 :packer-version: Version of packer to use.
147 lf-infra-push-gerrit-patch
148 --------------------------
150 Push a change through a Jenkins job to a Gerrit repository in an automated
151 way using git-review.
153 :Required parameters:
155 :gerrit-commit-message: Commit message to assign.
156 :gerrit-host: Gerrit hostname.
157 :gerrit-topic: Gerrit topic.
158 :gerrit-user: Gerrit user-id used for submitting the change.
159 :reviewers-email: Reviewers email. Space-separated list of
160 email addresses to CC on the patch.
161 :project: Gerrit project name.
163 .. _lf-infra-ship-logs:
168 Gather and deploy logs to a log server.
173 Retrieves system stats.
175 lf-infra-update-packer-images
176 -----------------------------
178 Find and update the new built cloud image{s} in the ci-management source
182 lf-jacoco-nojava-workaround
183 ---------------------------
185 Workaround for Jenkins not able to find Java in JaCoCo runs.
187 .. _lf-maven-central:
192 Publish artifacts to OSSRH (Maven Central) staging.
194 Requires that the project's settings.xml contains a ServerId 'ossrh' with the
195 credentials for the project's OSSRH account.
197 This macro assumes the directory ``$WORKSPACE/m2repo`` contains a Maven 2
198 repository which is to upload to OSSRH.
200 :Required parameters:
202 :mvn-central: Whether or not to upload to mvn-central. (true|false)
203 :mvn-global-settings: The name of the Maven global settings to use for
204 Maven configuration. (default: global-settings)
205 :mvn-settings: The name of settings file containing credentials for the
207 :ossrh-profile-id: Nexus staging profile ID as provided by OSSRH.
209 .. literalinclude:: ../../.jjb-test/lf-macros/lf-maven-central-minimal.yaml
212 .. _lf-maven-install:
217 Call maven-target builder with a goal of --version to force Jenkins to
218 install the need provided version of Maven. This is needed for any shell scripts
219 that want to use Maven.
221 :Required parameters:
223 :mvn-version: Version of Maven to install.
228 Call pip install to install packages into a virtualenv located in
231 .. note:: The first package listed in PIP_PACKAGES is used as the VENV name.
233 .. _lf-provide-maven-settings:
235 lf-provide-maven-settings
236 -------------------------
238 Push a global settings and user settings maven files to the build node.
240 lf-provide-maven-settings-cleanup
241 ---------------------------------
243 Cleanup maven settings.xml configuration. This should be called at the end of
244 any macros that calles the
245 :ref:`lf-provide-maven-settings <lf-provide-maven-settings>` macro.
250 Script to trigger a build on http://readthedocs.org
255 ReadTheDocs verify script. Installs and runs tox.
257 :Required parameters:
259 :doc-dir: Document directory.
260 :python-version: Python version.
265 ReadTheDocs Version 2 verify and merge scripts.
266 This is an update to the read the docs scripts that leverages the new Read the Docs v3 api
267 `RTD v3 API <https://docs.readthedocs.io/en/stable/api/v3.html>`_
268 Runs tox to verify that the docs are good and then runs the RTDv2 shell script.
269 This script handles creating projects as needed, assiging subprojects to the main
270 read the docs project and triggering builds to update the documentation.
276 Calls shell script to validate votes on a change to an INFO.yaml
281 releases lftools.ini (required)
282 needed to push to nexus.
288 Then runs ../shell/release-job.sh
294 Use Sigul to sign a directory via {sign-dir}.
296 Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
298 :Required Parameters:
299 :sign-artifacts: Whether or not to sign artifacts with Sigul.
300 :sign-dir: Directory to sign.
301 :sign-mode: serial|parallel
303 lf-infra-provide-docker-cleanup
304 -------------------------------
306 Forcibly removes all of the docker images.
311 Runs Jenkins SonarQube plug-in.
313 Requires ``SonarQube Scanner for Jenkins``
315 .. note:: Sonar properties can be set directly in the job definition by
316 setting the sonar-project-file to ``""`` and adding all properties under
317 ``sonar-properties``.
319 :Optional Parameters:
320 :sonar-task: Sonar task to run. (default: "")
321 :sonar-project-file: The filename for the project's properties
322 (default: "sonar-project.properties")
323 :sonar-properties: Sonar configuration properties. (default: "")
324 :sonar-java-opts: JVM options. (default: "")
325 :sonar-additional-args: Additional command line arguments. (default: "")
327 lf-infra-sonar-with-prescan
328 ---------------------------
330 Runs Jenkins SonarQube plug-in after a pre-scan builder, which is defined by
333 Requires ``SonarQube Scanner for Jenkins``
335 .. note:: Sonar properties can be set directly in the job definition by
336 setting the sonar-project-file to ``""`` and adding all properties under
337 ``sonar-properties``.
339 :Required Parameters:
340 :lf-sonar-prescan: A builder that will run prior to the Sonar scan.
342 :Optional Parameters:
343 :sonar-task: Sonar task to run. (default: "")
344 :sonar-project-file: The filename for the project's properties
345 (default: "sonar-project.properties")
346 :sonar-properties: Sonar configuration properties. (default: "")
347 :sonar-java-opts: JVM options. (default: "")
348 :sonar-additional-args: Additional command line arguments. (default: "")
356 Provides the policy evaluation stage to run against Nexus IQ Server.
357 Valid values include: 'build', 'stage-release', 'operate'.
362 Provides parameters needed by CMake. Should be used by any jobs that need to
363 call the ``cmake && make && make install`` pattern.
365 lf-infra-maven-parameters
366 -------------------------
368 Provides parameters needed by Maven. Should be used by any jobs that need to
371 lf-infra-openstack-parameters
372 -----------------------------
374 Provides parameters needed by OpenStack client CLI. Use in jobs that need to
375 call the openstack cli.
377 :Required Parameters:
379 :os-cloud: Configures ``OS_CLOUD`` envvar as used by openstack cli.
384 Standard parameters used in the LF CI environments. Gerrit variables are
385 not used by GitHub projects, but defining them is not harmful. Should be used
386 in every job template.
388 lf-infra-node-parameters
389 ------------------------
391 Provides parameters needed by NodeJS and NPM. Should be used by any jobs that
392 need to run NodeJS or NPM.
394 lf-infra-tox-parameters
395 -----------------------
397 Provides parameters needed by python-tox. Should be used by any jobs that need
398 to run `tox <https://tox.readthedocs.io>`.
401 lf-build-with-parameters-maven-release
402 --------------------------------------
404 Provides parameters needed for maven release jobs 'build with parameters'.
412 Configures the build-discarder plugin for Jenkins with the recommended lf-infra
413 settings. Should be used in all job-templates.
421 Provides basic configuration for the JaCoCo plugin.
426 Provides basic lf-infra recommended publisher configurations which should be
427 used in all job templates. This primary objective of this trigger is to
428 gather build logs and copy them to a log server.
430 lf-infra-publish-windows
431 ------------------------
433 Windows publisher for use at the end of Windows job templates. Takes care of
434 cleaning out the workspace at the end of a job.
442 Basic SCM configuration for Gerrit based projects.
444 :Required parameters:
446 :submodule-timeout: Timeout (in minutes) for checkout operation.
448 :submodule-disable: Disable submodule checkout operation.
454 Basic SCM configuration for GitHub based projects.
456 On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
457 as the value. This will require that the job be triggered via
458 the GHPRB plugin and not manually.
460 :Required parameters:
462 :submodule-timeout: Timeout (in minutes) for checkout operation.
464 :submodule-disable: Disable submodule checkout operation.
470 lf-infra-wrappers-common
471 ------------------------
473 Provides lf-infra recommended wrappers which should be used in every
474 job-template. It's meant to be used by more specific wrappers below.
479 Provides lf-infra recommended wrappers which should be used in every
480 job-template that's run on Linux systems.
482 This wrapper requires that a managed file called `npmrc` exists in the Jenkins.
483 The main use case here is to point to a npm proxy, on Nexus for example.
484 The type of the file should be "Custom file". You can set various npmrc
485 settings in it. Documentation on npm configuration can be found at
486 https://docs.npmjs.com/files/npmrc. If you are not using npm then it is fine
487 for the file to be empty.
493 registry=https://nexus3.onap.org/repository/npm.public/
495 lf-infra-wrappers-windows
496 -------------------------
498 Provides lf-infra recommended wrappers which should be used in every
499 job-template that's run on Windows systems.