8 lf-fetch-dependent-patches
9 --------------------------
11 Fetch all patches provided via comment trigger
13 This macro will fetch all patches provided via comment trigger and will
14 create a list of projects from those patches via environment variable
15 called DEPENDENCY_BUILD_ORDER which can be used if necessary to build
16 projects in the specified order. The order is determined by first patch
17 instance for a project in the patch list.
26 :file-patterns: Space-separated list of file patterns to scan.
27 For example: \*.go \*.groovy \*.java \*.py \*.sh
28 :spdx-disable: Disable the SPDX-Identifier checker.
29 :lhc-version: Version of LHC to use.
30 :license-exclude-paths: Comma-separated list of paths to exclude from the
31 license checker. The paths used here will be matched using a contains
32 rule so it is best to be as precise with the path as possible.
33 For example a path of '/src/generated/' will be searched as
34 '**/src/generated/**'.
35 Example: org/opendaylight/yang/gen,protobuff/messages
36 :licenses-allowed: Comma-separated list of allowed licenses.
37 For example: Apache-2.0,EPL-1.0,MIT
42 Create a ~/.netrc file from a Maven settings.xml
46 :server-id: The id of a server as defined in settings.xml.
50 :ALT_NEXUS_SERVER: URL of custom nexus server.
51 If set this will take precedence.
52 Use this to point at nexus3.$PROJECTDOMAIN
55 lf-infra-deploy-maven-file
56 --------------------------
58 Deploy files to a repository.
62 :global-settings-file: Global settings file to use.
63 :group-id: Group ID of the repository.
64 :maven-repo-url: URL of a Maven repository to upload to.
65 :mvn-version: Version of Maven to use.
66 :repo-id: Repository ID
67 :settings-file: Maven settings file to use.
68 :upload-files-dir: Path to directory containing one or more files
73 Login into a custom hosted docker registry and / or docker.io
75 The Jenkins system should have the following global variables defined
77 :Environment variables:
79 :DOCKER_REGISTRY: The DNS address of the registry (IP or FQDN)
80 ex: nexus3.example.com (GLOBAL variable)
82 :REGISTRY_PORTS: Required if DOCKER_REGISTRY is set. Space separated list
83 of the registry ports to login to. ex: 10001 10002 10003 10004
86 :DOCKERHUB_EMAIL: If this variable is set then an attempt to login to
87 DockerHub (docker.io) will be also made. It should be set to the email
88 address for the credentials that will get looked up. Only _one_
89 credential will ever be found in the maven settings file for DockerHub.
92 lf-infra-gpg-verify-git-signature
93 ---------------------------------
95 Verify gpg signature of the latest commit message in $WORKSPACE.
96 This command assumes that $WORKSPACE is a git repo.
101 Macro that runs before all builders to prepare the system for job use.
103 lf-infra-package-listing
104 ------------------------
106 Lists distro level packages.
108 lf-infra-packer-build
109 ---------------------
111 Run `packer build` to build system images.
113 lf-infra-packer-validate
114 ------------------------
116 Run `packer validate` to verify packer configuration.
118 :Required parameters:
120 :packer-cloud-settings: Cloud configuration file. Loaded on the build
121 server as CLOUDENV environment variable.
122 :packer-version: Version of packer to use.
124 lf-infra-push-gerrit-patch
125 --------------------------
127 Push a change through a Jenkins job to a Gerrit repository in an automated
128 way using git-review.
130 :Required parameters:
132 :gerrit-commit-message: Commit message to assign.
133 :gerrit-host: Gerrit hostname.
134 :gerrit-topic: Gerrit topic.
135 :gerrit-user: Gerrit user-id used for submitting the change.
136 :reviewers-email: Reviewers email. Space-separated list of
137 email addresses to CC on the patch.
138 :project: Gerrit project name.
140 .. _lf-infra-ship-logs:
145 Gather and deploy logs to a log server.
150 Retrieves system stats.
152 lf-jacoco-nojava-workaround
153 ---------------------------
155 Workaround for Jenkins not able to find Java in JaCoCo runs.
160 Call maven-target builder with a goal of --version to force Jenkins to
161 install the need provided version of Maven. This is needed for any shell scripts
162 that want to use Maven.
164 :Required parameters:
166 :mvn-version: Version of Maven to install.
171 Call pip install to install packages into a virtualenv located in
174 .. note:: The first package listed in PIP_PACKAGES is used as the VENV name.
176 .. _lf-provide-maven-settings:
178 lf-provide-maven-settings
179 -------------------------
181 Push a global settings and user settings maven files to the build node.
183 lf-provide-maven-settings-cleanup
184 ---------------------------------
186 Cleanup maven settings.xml configuration. This should be called at the end of
187 any macros that calles the
188 :ref:`lf-provide-maven-settings <lf-provide-maven-settings>` macro.
190 .. _provide-sigul-config:
192 lf-provide-sigul-configuration
193 ------------------------------
195 Provides sigual configuration to the Jenkins build node.
197 Requires the following Config File Provider managed files in Jenkins
204 .. _provide-sigul-config-cleanup:
206 lf-provide-sigul-configuration-cleanup
207 --------------------------------------
209 Cleanup configuration provided by `provide-sigul-config`.
214 Script to trigger a build on http://readthedocs.org
219 ReadTheDocs verify script.
226 Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
228 lf-infra-provide-docker-cleanup
229 -------------------------------
231 Forcibly removes all of the docker images.
239 Provides the policy evaluation stage to run against Nexus IQ Server.
240 Valid values include: 'build', 'stage-release', 'operate'.
245 Provides parameters needed by CMake. Should be used by any jobs that need to
246 call the ``cmake && make && make install`` pattern.
248 lf-infra-maven-parameters
249 -------------------------
251 Provides parameters needed by Maven. Should be used by any jobs that need to
254 lf-infra-openstack-parameters
255 -----------------------------
257 Provides parameters needed by OpenStack client CLI. Use in jobs that need to
258 call the openstack cli.
260 :Required Parameters:
262 :os-cloud: Configures ``OS_CLOUD`` envvar as used by openstack cli.
267 Standard parameters used in the LF CI environments. Gerrit variables are
268 not used by GitHub projects, but defining them is not harmful. Should be used
269 in every job template.
271 lf-infra-node-parameters
272 ------------------------
274 Provides parameters needed by NodeJS and NPM. Should be used by any jobs that
275 need to run NodeJS or NPM.
277 lf-infra-tox-parameters
278 -----------------------
280 Provides parameters needed by python-tox. Should be used by any jobs that need
281 to run `tox <https://tox.readthedocs.io>`.
289 Configures the build-discarder plugin for Jenkins with the recommended lf-infra
290 settings. Should be used in all job-templates.
298 Provides basic configuration for the JaCoCo plugin.
303 Provides basic lf-infra recommended publisher configurations which should be
304 used in all job templates. This primary objective of this trigger is to
305 gather build logs and copy them to a log server.
313 Basic SCM configuration for Gerrit based projects.
318 Basic SCM configuration for GitHub based projects.
320 On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
321 as the value. This will require that the job be triggered via
322 the GHPRB plugin and not manually.
330 Provides lf-infra recommended wrappers which should be used in every
333 This wrapper requires that a managed file called `npmrc` exists in the Jenkins. The main use
334 case here is to point to a npm proxy, on Nexus for example.
335 The type of the file should be "Custom file". You can set various npmrc settings in it.
336 Documentation on npm configuration can be found at https://docs.npmjs.com/files/npmrc.
337 If you are not using npm then it is fine for the file to be empty.
343 registry=https://nexus3.onap.org/repository/npm.public/