8 {project-name}-maven-jobs
9 -------------------------
11 Jobs for Maven projects using Gerrit.
16 - gerrit-maven-release
18 - gerrit-maven-verify-dependencies
20 {project-name}-github-maven-jobs
21 --------------------------------
23 Jobs for Maven projects using GitHub.
28 - github-maven-release
31 {project-name}-maven-javadoc-jobs
32 ---------------------------------
34 Jobs for Maven projects to generate javadoc using Gerrit.
38 - gerrit-maven-javadoc-publish
39 - gerrit-maven-javadoc-verify
41 {project-name}-github-maven-javadoc-jobs
42 ----------------------------------------
44 Jobs for Maven projects to generate javadoc using GitHub.
48 - github-maven-javadoc-publish
49 - github-maven-javadoc-verify
58 Runs Sonar against a Maven project.
62 :java-version: Version of Java to execute Sonar with.
63 :mvn-version: Version of Maven to execute Sonar with.
64 :mvn-settings: Maven settings.xml file containing credentials to use.
69 Calls the maven build script to perform a maven build.
73 :mvn-goals: The maven goals to perform for the build.
74 (default: clean deploy)
79 Common Jenkins configuration for Maven jobs.
84 Calls the maven deploy script to push artifacts to Nexus.
89 Calls the maven stage script to push artifacts to a Nexus staging repository.
91 lf-update-java-alternatives
92 ---------------------------
94 Setup Java alternatives for the Distro.
98 :java-version: Version of Java to set as the default Java.
107 Produces a CLM scan of the code into Nexus IQ Server.
111 - {project-name}-maven-clm-{stream}
115 :Comment Trigger: run-clm
117 :Required parameters:
119 :build-node: The node to run build on.
120 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
121 be configured in defaults.yaml)
122 :mvn-settings: The name of settings file containing credentials for the project.
124 :Optional parameters:
126 :branch: The branch to build against. (default: master)
127 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
128 :build-timeout: Timeout in minutes before aborting build. (default: 60)
129 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
130 :java-version: Version of Java to use for the build. (default: openjdk8)
131 :mvn-global-settings: The name of the Maven global settings to use for
132 Maven configuration. (default: global-settings)
133 :mvn-opts: Sets MAVEN_OPTS. (default: '')
134 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
135 :mvn-version: Version of maven to use. (default: mvn35)
136 :nexus-iq-stage: Stage the policy evaluation will be run against on
137 the Nexus IQ Server. (default: 'build')
138 :stream: Keyword that can be used to represent a release code-name.
139 Often the same as the branch. (default: master)
140 :submodule-recursive: Whether to checkout submodules recursively.
143 :gerrit_merge_triggers: Override Gerrit Triggers.
145 Maven JavaDoc Publish
146 ---------------------
148 Produces and publishes javadocs for a Maven project.
150 Expects javadocs to be available in $WORKSPACE/target/site/apidocs
154 - {project-name}-maven-javadoc-publish-{stream}
155 - gerrit-maven-javadoc-publish
156 - github-maven-javadoc-publish
158 :Comment Trigger: remerge
160 :Required parameters:
162 :build-node: The node to run build on.
163 :javadoc-path: The path in Nexus to deploy javadoc to.
164 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
165 be configured in defaults.yaml)
166 :mvn-settings: The name of settings file containing credentials for the project.
167 :mvn-site-id: Maven Server ID from settings.xml to pull credentials from.
168 (Note: This setting should be configured in defaults.yaml.)
170 :Optional parameters:
172 :branch: The branch to build against. (default: master)
173 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
174 :build-timeout: Timeout in minutes before aborting build. (default: 60)
175 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
176 :java-version: Version of Java to use for the build. (default: openjdk8)
177 :mvn-global-settings: The name of the Maven global settings to use for
178 Maven configuration. (default: global-settings)
179 :mvn-opts: Sets MAVEN_OPTS. (default: '')
180 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
181 :mvn-version: Version of maven to use. (default: mvn35)
182 :stream: Keyword that can be used to represent a release code-name.
183 Often the same as the branch. (default: master)
184 :submodule-recursive: Whether to checkout submodules recursively.
187 :gerrit_merge_triggers: Override Gerrit Triggers.
192 Produces javadocs for a Maven project.
194 Expects javadocs to be available in $WORKSPACE/target/site/apidocs
198 - {project-name}-maven-javadoc-verify-{stream}
199 - gerrit-maven-javadoc-verify
200 - github-maven-javadoc-verify
202 :Comment Trigger: recheck|reverify
204 :Required parameters:
205 :build-node: The node to run build on.
206 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
207 be configured in defaults.yaml)
208 :mvn-settings: The name of settings file containing credentials for the project.
210 :Optional parameters:
212 :branch: The branch to build against. (default: master)
213 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
214 :build-timeout: Timeout in minutes before aborting build. (default: 60)
215 :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
216 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
217 :java-version: Version of Java to use for the build. (default: openjdk8)
218 :mvn-global-settings: The name of the Maven global settings to use for
219 Maven configuration. (default: global-settings)
220 :mvn-opts: Sets MAVEN_OPTS. (default: '')
221 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
222 :mvn-version: Version of maven to use. (default: mvn35)
223 :stream: Keyword that can be used to represent a release code-name.
224 Often the same as the branch. (default: master)
225 :submodule-recursive: Whether to checkout submodules recursively.
228 :gerrit_verify_triggers: Override Gerrit Triggers.
233 Merge job which runs `mvn clean deploy` to build a project.
235 This job pushes files to Nexus using cURL instead of allowing the Maven deploy
236 goal to push the upload. This is to get around the issue that Maven deploy does
237 not properly support uploading files at the end of the build and instead pushes
238 as it goes. There exists a `-Ddeploy-at-end` feature however it does not work
241 This job uses the following strategy to deploy jobs to Nexus:
243 1. `wget -r` to fetch maven-metadata.xml from Nexus
244 2. `mvn deploy -DaltDeploymentRepository` to prepare files for upload
245 3. Removes untouched maven-metadata.xml files before upload
246 4. Use lftools (cURL) upload script to push artifacts to Nexus
250 - {project-name}-maven-merge-{stream}
254 :Comment Trigger: remerge
256 :Required parameters:
258 :build-node: The node to run build on.
259 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
260 be configured in defaults.yaml)
261 :mvn-settings: The name of settings file containing credentials for the project.
262 :mvn-snapshot-id: Maven Server ID from settings.xml to pull credentials from.
263 (Note: This setting should be configured in defaults.yaml.)
264 :nexus-snapshot-repo: The repository id of the Nexus snapshot repo to deploy to.
266 :Optional parameters:
268 :branch: Git branch to fetch for the build. (default: master)
269 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
270 :build-timeout: Timeout in minutes before aborting build. (default: 60)
271 :cron: Cron schedule when to trigger the job. This parameter also
272 supports multiline input via YAML pipe | character in cases where
273 one may want to provide more than 1 cron timer. (default: 'H H * * 0'
275 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
276 :java-version: Version of Java to use for the build. (default: openjdk8)
277 :mvn-global-settings: The name of the Maven global settings to use for
278 Maven configuration. (default: global-settings)
279 :mvn-opts: Sets MAVEN_OPTS. (default: '')
280 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
281 :mvn-version: Version of maven to use. (default: mvn35)
282 :nexus-cut-dirs: Number of directories to cut from file path for `wget -r`.
283 :stream: Keyword that can be used to represent a release code-name.
284 Often the same as the branch. (default: master)
285 :submodule-recursive: Whether to checkout submodules recursively.
288 :gerrit_merge_triggers: Override Gerrit Triggers.
289 :gerrit_trigger_file_paths: Override file paths which can be used to
290 filter which file modifications will trigger a build.
295 Produces a release candidate by creating a staging repo in Nexus.
297 Runs a Maven build and deploys to $WORKSPACE/m2repo directory. This
298 directory can then be reused later to deploy to Nexus.
302 - {project-name}-maven-release-{stream}
303 - gerrit-maven-release
304 - github-maven-release
306 :Required parameters:
308 :build-node: The node to run build on.
309 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
310 be configured in defaults.yaml)
311 :mvn-settings: The name of settings file containing credentials for the project.
312 :mvn-staging-id: Maven Server ID from settings.xml to pull credentials from.
313 (Note: This setting should be configured in defaults.yaml.)
314 :staging-profile-id: Profile ID of the project's Nexus staging profile.
316 :Optional parameters:
318 :archive-artifacts: Artifacts to archive to the logs server (default: '').
319 :branch: The branch to build against. (default: master)
320 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
321 :build-timeout: Timeout in minutes before aborting build. (default: 60)
322 :cron: Cron schedule when to trigger the job. This parameter also
323 supports multiline input via YAML pipe | character in cases where
324 one may want to provide more than 1 cron timer. (default: '')
325 :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
326 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
327 :java-version: Version of Java to use for the build. (default: openjdk8)
328 :mvn-global-settings: The name of the Maven global settings to use for
329 Maven configuration. (default: global-settings)
330 :mvn-opts: Sets MAVEN_OPTS. (default: '')
331 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
332 :mvn-version: Version of maven to use. (default: mvn35)
333 :stream: Keyword that can be used to represent a release code-name.
334 Often the same as the branch. (default: master)
335 :submodule-recursive: Whether to checkout submodules recursively.
338 :gerrit_release_triggers: Override Gerrit Triggers.
343 Sonar job which runs mvn clean install then publishes to Sonar.
345 This job purposely only runs on the master branch as there are Additional
346 configuration needed to support multiple branches and there's not much
347 interest in that kind of support.
351 - {project-name}-sonar
355 :Comment Trigger: run-sonar
357 :Required parameters:
359 :build-node: The node to run build on.
360 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
361 be configured in defaults.yaml)
362 :mvn-settings: The name of settings file containing credentials for the project.
364 :Optional parameters:
366 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
367 :build-timeout: Timeout in minutes before aborting build. (default: 60)
368 :cron: Cron schedule when to trigger the job. This parameter also
369 supports multiline input via YAML pipe | character in cases where
370 one may want to provide more than 1 cron timer. (default: 'H H * * 6'
372 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
373 :java-version: Version of Java to use for the build. (default: openjdk8)
374 :mvn-global-settings: The name of the Maven global settings to use for
375 Maven configuration. (default: global-settings)
376 :mvn-opts: Sets MAVEN_OPTS. (default: '')
377 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
378 :mvn-version: Version of maven to use. (default: mvn35)
379 :stream: Keyword that can be used to represent a release code-name.
380 Often the same as the branch. (default: master)
381 :submodule-recursive: Whether to checkout submodules recursively.
384 :gerrit_sonar_triggers: Override Gerrit Triggers.
389 Verify job which runs mvn clean install to test a project build..
393 - {project-name}-maven-verify-{stream}-{mvn-version}-{java-version}
394 - gerrit-maven-verify
395 - github-maven-verify
397 :Comment Trigger: recheck|reverify
399 :Required parameters:
401 :build-node: The node to run build on.
402 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
403 be configured in defaults.yaml)
404 :mvn-settings: The name of settings file containing credentials for the project.
406 :Optional parameters:
408 :branch: Git branch to fetch for the build. (default: master)
409 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
410 :build-timeout: Timeout in minutes before aborting build. (default: 60)
411 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
412 :java-version: Version of Java to use for the build. (default: openjdk8)
413 :mvn-global-settings: The name of the Maven global settings to use for
414 Maven configuration. (default: global-settings)
415 :mvn-opts: Sets MAVEN_OPTS. (default: '')
416 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
417 :mvn-version: Version of maven to use. (default: mvn35)
418 :stream: Keyword that can be used to represent a release code-name.
419 Often the same as the branch. (default: master)
420 :submodule-recursive: Whether to checkout submodules recursively.
423 :gerrit_verify_triggers: Override Gerrit Triggers.
424 :gerrit_trigger_file_paths: Override file paths which can be used to
425 filter which file modifications will trigger a build.
427 Maven Verify /w Dependencies
428 ----------------------------
430 Verify job which runs mvn clean install to test a project build /w deps
432 This job can be used to verify a patch in conjunction to all of the
433 upstream patches it depends on. The user of this job can provide a list
438 - {project-name}-maven-verify-deps-{stream}-{mvn-version}-{java-version}
439 - gerrit-maven-verify-dependencies
441 :Comment Trigger: recheck: SPACE_SEPERATED_LIST_OF_PATCHES
443 :Required parameters:
445 :build-node: The node to run build on.
446 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
447 be configured in defaults.yaml)
448 :mvn-settings: The name of settings file containing credentials for the project.
450 :Optional parameters:
452 :branch: Git branch to fetch for the build. (default: master)
453 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
454 :build-timeout: Timeout in minutes before aborting build. (default: 60)
455 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
456 :java-version: Version of Java to use for the build. (default: openjdk8)
457 :mvn-global-settings: The name of the Maven global settings to use for
458 Maven configuration. (default: global-settings)
459 :mvn-opts: Sets MAVEN_OPTS. (default: '')
460 :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
461 :mvn-version: Version of maven to use. (default: mvn35)
462 :stream: Keyword that can be used to represent a release code-name.
463 Often the same as the branch. (default: master)
464 :submodule-recursive: Whether to checkout submodules recursively.
467 :gerrit_verify_triggers: Override Gerrit Triggers.
468 :gerrit_trigger_file_paths: Override file paths which can be used to
469 filter which file modifications will trigger a build.