8 .. include:: ../job-groups.rst
10 Below is a list of Maven job groups:
12 .. literalinclude:: ../../jjb/lf-maven-job-groups.yaml
22 Runs Sonar against a Maven project.
26 :java-version: Version of Java to execute Sonar with. (default: openjdk11)
27 :mvn-version: Version of Maven to execute Sonar with.
28 :mvn-settings: Maven settings.xml file containing credentials to use.
30 lf-infra-maven-sonarcloud
31 -------------------------
33 Runs Sonar against a Maven project and pushes results to SonarCloud.
37 :java-version: Version of Java to execute Maven build. (default: openjdk11)
38 :mvn-version: Version of Maven to execute Sonar with.
39 :mvn-settings: Maven settings.xml file containing credentials to use.
40 :sonarcloud-project-key: SonarCloud project key.
41 :sonarcloud-project-organization: SonarCloud project organization.
42 :sonarcloud-java-version: Version of Java to run the Sonar scan. (default: openjdk11)
43 :sonarcloud-qualitygate-wait: SonarCloud flag that forces the analysis step to
44 wait for the quality gate result. (default: false)
49 Calls the maven build script to perform a maven build.
53 :mvn-goals: The maven goals to perform for the build.
54 (default: clean deploy)
59 Common Jenkins configuration for Maven jobs.
64 Calls the maven deploy script to push artifacts to Nexus.
66 lf-maven-versions-plugin
67 ------------------------
69 Conditionally calls Maven versions plugin to set, update and commit the maven `versions:set`.
73 :maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
74 :version-properties-file: Name and path of the version properties file.
75 (default: version.properties)
76 :mvn-version: Version of Maven to execute Sonar with.
77 :mvn-pom: Location of pom.xml.
78 :mvn-settings: Maven settings.xml file containing credentials to use.
83 Calls the maven stage script to push artifacts to a Nexus staging repository.
87 :mvn-global-settings: The name of the Maven global settings to use for
89 :mvn-settings: The name of settings file containing credentials for the project.
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.
101 lf-infra-sonatype-clm
102 ---------------------
104 Runs a Sonatype CLM scan against a Maven project and pushes results to
107 :Optional parameters:
108 :mvn-goals: The maven goals to perform for the build.
109 (default: clean install)
111 lf-infra-snyk-cli-scanner
112 -------------------------
114 Downloads the latest Snyk CLI and triggers a code scan. It publishes a report into
117 :Optional parameters:
118 :mvn-goals: The maven goals to perform for the build.
119 (default: clean install)
121 lf-infra-maven-sbom-generator
122 -----------------------------
124 Runs a specific version of SPDX SBOM Generator tool to generate a report.
125 The calling job template sets the version to run in the SBOM_GENERATOR_VERSION parameter.
127 :Optional parameters:
128 :sbom-flags: SBOM generator options. See https://github.com/opensbom-generator/spdx-sbom-generator
136 Produces a CLM scan of the code into Nexus IQ Server.
140 - {project-name}-maven-clm-{stream}
144 :Comment Trigger: run-clm
146 :Required parameters:
148 :build-node: The node to run build on.
149 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
150 :mvn-settings: The name of settings file containing credentials for the project.
152 :Optional parameters:
154 :branch: The branch to build against. (default: master)
155 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
156 :build-timeout: Timeout in minutes before aborting build. (default: 60)
157 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
158 :java-version: Version of Java to use for the build. (default: openjdk11)
159 :mvn-global-settings: The name of the Maven global settings to use for
160 Maven configuration. (default: global-settings)
161 :mvn-goals: The maven goals to perform for the build.
162 (default: clean install)
163 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
164 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
165 :mvn-version: Version of maven to use. (default: mvn35)
166 :nexus-iq-namespace: Insert a namespace to project AppID for projects that
167 share a Nexus IQ system to avoid project name collision. We recommend
168 inserting a trailing - dash if using this parameter.
169 For example 'odl-'. (default: '')
170 :nexus-iq-stage: Sets the **stage** which the policy evaluation will run
171 against on the Nexus IQ Server. (default: 'build')
172 :stream: Keyword that represents a release code-name.
173 Often the same as the branch. (default: master)
174 :submodule-recursive: Whether to checkout submodules recursively.
176 :submodule-timeout: Timeout (in minutes) for checkout operation.
178 :submodule-disable: Disable submodule checkout operation.
181 :gerrit_merge_triggers: Override Gerrit Triggers.
186 Builds the code, downloads and runs a Snyk CLI scan of the code into the Snyk dashboard.
190 - {project-name}-maven-snyk-cli-{stream}
191 - gerrit-maven-snyk-cli
192 - github-maven-snyk-cli
194 :Comment Trigger: run-snyk
196 :Required parameters:
198 :build-node: The node to run build on.
199 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
200 :mvn-settings: The name of settings file containing credentials for the project.
201 :snyk-token-credential-id: Snyk API token to communicate with Jenkins.
202 :snyk-org-credential-id: Snyk organization ID.
204 :Optional parameters:
206 :branch: The branch to build against. (default: master)
207 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
208 :build-timeout: Timeout in minutes before aborting build. (default: 60)
209 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
210 :java-version: Version of Java to use for the build. (default: openjdk11)
211 :mvn-global-settings: The name of the Maven global settings to use for
212 Maven configuration. (default: global-settings)
213 :mvn-goals: The maven goals to perform for the build.
214 (default: clean install)
215 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
216 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
217 :mvn-version: Version of maven to use. (default: mvn35)
218 :snyk-cli-options: Snyk CLI options. (default: '')
219 :stream: Keyword that represents a release code-name.
220 Often the same as the branch. (default: master)
221 :submodule-recursive: Whether to checkout submodules recursively.
223 :submodule-timeout: Timeout (in minutes) for checkout operation.
225 :submodule-disable: Disable submodule checkout operation.
228 :gerrit_snyk_triggers: Override Gerrit Triggers.
230 Maven JavaDoc Publish
231 ---------------------
233 Produces and publishes javadocs for a Maven project.
235 Expects javadocs to be available in ``$WORKSPACE/target/site/apidocs``, but
236 overrideable with the ``mvn-dir`` parameter. If set, will search for javadocs
237 in ``$WORKSPACE/{mvn-dir}/target/site/apidocs``.
241 - {project-name}-maven-javadoc-publish-{stream}-{java-version}
242 - gerrit-maven-javadoc-publish
243 - github-maven-javadoc-publish
245 :Comment Trigger: remerge
247 :Required parameters:
249 :build-node: The node to run build on.
250 :javadoc-path: The path in Nexus to deploy javadoc to.
251 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
252 :mvn-settings: The name of settings file containing credentials for the project.
253 :mvn-site-id: Maven Server ID from settings.xml to pull credentials from.
254 (Note: This setting is generally configured in ``defaults.yaml``.)
256 :Optional parameters:
258 :branch: The branch to build against. (default: master)
259 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
260 :build-timeout: Timeout in minutes before aborting build. (default: 60)
261 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
262 :java-version: Version of Java to use for the build. (default: openjdk11)
263 :mvn-dir: Directory supplied as argument to -f option (default: '.')
264 :mvn-global-settings: The name of the Maven global settings to use for
265 Maven configuration. (default: global-settings)
266 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
267 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
268 Must not include a "-f" option; see parameter mvn-dir.
269 :mvn-version: Version of maven to use. (default: mvn35)
270 :stream: Keyword that represents a release code-name.
271 Often the same as the branch. (default: master)
272 :submodule-recursive: Whether to checkout submodules recursively.
274 :submodule-timeout: Timeout (in minutes) for checkout operation.
276 :submodule-disable: Disable submodule checkout operation.
279 :gerrit_merge_triggers: Override Gerrit Triggers.
284 Produces javadocs for a Maven project.
286 Expects javadocs to be available in ``$WORKSPACE/target/site/apidocs``, but
287 overrideable with the ``mvn-dir`` parameter. If set, will search for javadocs
288 in ``$WORKSPACE/{mvn-dir}/target/site/apidocs``.
292 - {project-name}-maven-javadoc-verify-{stream}-{java-version}
293 - gerrit-maven-javadoc-verify
294 - github-maven-javadoc-verify
296 :Comment Trigger: recheck|reverify
298 :Required parameters:
299 :build-node: The node to run build on.
300 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
301 :mvn-settings: The name of settings file containing credentials for the project.
303 :Optional parameters:
305 :branch: The branch to build against. (default: master)
306 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
307 :build-timeout: Timeout in minutes before aborting build. (default: 60)
308 :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
309 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
310 :java-version: Version of Java to use for the build. (default: openjdk11)
311 :mvn-dir: Directory supplied as argument to -f option (default: '.')
312 :mvn-global-settings: The name of the Maven global settings to use for
313 Maven configuration. (default: global-settings)
314 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
315 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
316 Must not include a "-f" option; see parameter mvn-dir.
317 :mvn-version: Version of maven to use. (default: mvn35)
318 :stream: Keyword that represents a release code-name.
319 Often the same as the branch. (default: master)
320 :submodule-recursive: Whether to checkout submodules recursively.
322 :submodule-timeout: Timeout (in minutes) for checkout operation.
324 :submodule-disable: Disable submodule checkout operation.
327 :gerrit_verify_triggers: Override Gerrit Triggers.
332 Merge job which runs `mvn clean deploy` to build a project.
334 This job pushes files to Nexus using cURL instead of allowing the Maven deploy
335 goal to push the upload. This is to get around the issue that Maven deploy does
336 not properly support uploading files at the end of the build and instead pushes
337 as it goes. There exists a ``-Ddeploy-at-end`` feature but it does not work
340 This job uses the following strategy to deploy jobs to Nexus:
342 1. ``wget -r`` to fetch maven-metadata.xml from Nexus
343 2. ``mvn deploy -DaltDeploymentRepository`` to prepare files for upload
344 3. Removes untouched maven-metadata.xml files before upload
345 4. Use lftools (cURL) upload script to push artifacts to Nexus
349 - {project-name}-maven-merge-{stream}
353 :Comment Trigger: remerge
355 :Required parameters:
357 :build-node: The node to run build on.
358 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
359 :mvn-settings: The name of settings file containing credentials for the project.
360 :mvn-snapshot-id: Maven Server ID from settings.xml to pull credentials from.
361 (Note: This setting is generally configured in ``defaults.yaml``.)
362 :nexus-snapshot-repo: The repository id of the Nexus snapshot repo to deploy to.
364 :Optional parameters:
366 :branch: Git branch to fetch for the build. (default: master)
367 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
368 :build-timeout: Timeout in minutes before aborting build. (default: 60)
369 :cron: Cron schedule when to trigger the job. This parameter also
370 supports multiline input via YAML pipe | character in cases where
371 one may want to provide more than 1 cron timer. (default: 'H H * * 0'
373 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
374 :java-version: Version of Java to use for the build. (default: openjdk11)
375 :mvn-global-settings: The name of the Maven global settings to use for
376 Maven configuration. (default: global-settings)
377 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
378 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
379 :mvn-version: Version of maven to use. (default: mvn35)
380 :nexus-cut-dirs: Number of directories to cut from file path for `wget -r`.
381 :pre-build-script: Shell script to run before maven build. (default: a string with a shell comment)
382 :post-build-script: Shell script to run after maven build. (default: a string with a shell comment)
383 :stream: Keyword that represents a release code-name.
384 Often the same as the branch. (default: master)
385 :submodule-recursive: Whether to checkout submodules recursively.
387 :submodule-timeout: Timeout (in minutes) for checkout operation.
389 :submodule-disable: Disable submodule checkout operation.
392 :gerrit_merge_triggers: Override Gerrit Triggers.
393 :gerrit_trigger_file_paths: Override file paths to filter which file
394 modifications will trigger a build.
396 Maven Merge for Docker
397 ----------------------
399 Produces a snapshot docker image in a Nexus registry. Appropriate for
400 Java projects that do not need to deploy any POM or JAR files.
402 Like the Maven Merge job as described above but logs in to Docker
403 registries first and skips the lf-maven-deploy builder. The project
404 POM file should invoke a plugin to build and push a Docker image.
405 This pulls the base image from the registry in the environment
406 variable ``CONTAINER_PULL_REGISTRY`` and pushes new image into the
407 registry in the environment variable ``CONTAINER_PUSH_REGISTRY``.
411 - {project-name}-maven-docker-merge-{stream}
412 - gerrit-maven-docker-merge
413 - github-maven-docker-merge
415 :Required parameters:
417 :container-public-registry: Docker registry source with base images.
418 :container-snapshot-registry: Docker registry target for the deploy action.
420 All other required and optional parameters are identical to the Maven Merge job
426 Produces a release candidate by creating a staging repo in Nexus.
428 The staging repo name is in the format PROJECT-NUMBER for example "aaa-1234",
429 "autorelease-2000", "odlparent-1201", etc...
431 This job runs a Maven build and deploys to $WORKSPACE/m2repo directory. This
432 directory is then used later to deploy to Nexus.
436 - {project-name}-maven-stage-{stream}
440 :Comment Trigger: "stage-release" or "stage-maven-release"
442 :Required parameters:
444 :build-node: The node to run build on.
445 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
446 :mvn-settings: The name of settings file containing credentials for the project.
447 :mvn-staging-id: Maven Server ID from settings.xml to pull credentials from.
448 (Note: This setting is generally configured in ``defaults.yaml``.)
449 :staging-profile-id: Profile ID of the project's Nexus staging profile.
451 :Optional parameters:
453 :archive-artifacts: Artifacts to archive to the logs server (default: '').
454 :branch: The branch to build against. (default: master)
455 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
456 :build-timeout: Timeout in minutes before aborting build. (default: 60)
457 :cron: Cron schedule when to trigger the job. This parameter also
458 supports multiline input via YAML pipe | character in cases where
459 one may want to provide more than 1 cron timer. (default: '')
460 :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
461 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
462 :java-version: Version of Java to use for the build. (default: openjdk11)
463 :mvn-central: Set to ``true`` to also stage to **OSSRH**. This is for projects
464 that want to release to Maven Central. If set, then also set the parameter
465 ``ossrh-profile-id``. (default: false)
466 :maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
467 :mvn-global-settings: The name of the Maven global settings to use for
468 Maven configuration. (default: global-settings)
469 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
470 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
471 :mvn-version: Version of maven to use. (default: mvn35)
472 :ossrh-profile-id: Profile ID for project as provided by OSSRH.
474 :sbom-flags: SBOM generator options if using sbom-generator.
475 See https://github.com/opensbom-generator/spdx-sbom-generator
476 :sbom-generator: Calls lf-infra-maven-sbom-generator to run the SPDX SBOM generator tool.
478 :sbom-generator-version: SBOM generator version to download and run if using sbom-generator.
480 :sbom-path: SBOM execution path.
481 (default: $WORKSPACE)
482 :sign-artifacts: Sign artifacts with Sigul. (default: false)
483 :stream: Keyword that represents a release code-name.
484 Often the same as the branch. (default: master)
485 :submodule-recursive: Whether to checkout submodules recursively.
487 :submodule-timeout: Timeout (in minutes) for checkout operation.
489 :submodule-disable: Disable submodule checkout operation.
491 :version-properties-file: Name and path of the version properties file.
492 (default: version.properties)
494 :gerrit_release_triggers: Override Gerrit Triggers.
495 :gerrit_trigger_file_paths: Override file paths to filter which file
496 modifications will trigger a build.
498 Maven Stage for Docker
499 ----------------------
501 Produces a release candidate docker image in a Nexus registry.
502 Appropriate for Java projects that do not need to deploy any POM or
505 Like the Maven Stage job as described above but logs in to Docker
506 registries first and skips the lf-maven-deploy builder. The project
507 POM file should invoke a plugin to build and push a Docker image.
508 This pulls the base image from the registry in the environment
509 variable ``CONTAINER_PULL_REGISTRY`` and pushes new image into the
510 registry in the environment variable ``CONTAINER_PUSH_REGISTRY``.
514 - {project-name}-maven-docker-stage-{stream}
515 - gerrit-maven-docker-stage
516 - github-maven-docker-stage
518 :Comment Trigger: "stage-release" or "stage-docker-release"
520 :Required parameters:
522 :container-public-registry: Docker registry source with base images.
523 :container-staging-registry: Docker registry target for the deploy action.
525 :Optional parameters:
527 :gerrit_release_docker_triggers: Override Gerrit Triggers.
529 All other required and optional parameters are identical to the Maven Stage job
537 Sonar job which runs mvn clean install then publishes to Sonar.
539 This job purposely runs on the ``master`` branch and does not support
540 multi-branch configuration.
544 - {project-name}-sonar
547 - {project-name}-sonar-prescan-script
548 - gerrit-maven-sonar-prescan-script
549 - github-maven-sonar-prescan-script
551 :Comment Trigger: run-sonar
553 :Required parameters:
555 :build-node: The node to run build on.
556 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
557 :mvn-settings: The name of settings file containing credentials for the project.
558 :sonar-prescan-script: (maven-sonar-prescan-script jobs) A shell script to run before
561 :Optional parameters:
563 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
564 :build-timeout: Timeout in minutes before aborting build. (default: 60)
565 :cron: Cron schedule when to trigger the job. This parameter also
566 supports multiline input via YAML pipe | character in cases where
567 one may want to provide more than 1 cron timer. (default: 'H H * * 6'
569 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
570 :java-version: Version of Java to use for the Maven build. (default: openjdk11)
571 :mvn-global-settings: The name of the Maven global settings to use for
572 Maven configuration. (default: global-settings)
573 :mvn-goals: The maven goals to perform for the build.
574 (default: clean install)
575 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
576 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
577 :mvn-version: Version of maven to use. (default: mvn35)
578 :sonar-mvn-goals: Maven goals to run for sonar analysis.
579 (default: sonar:sonar)
580 :sonarcloud: Set to ``true`` to use SonarCloud ``true|false``.
582 :sonarcloud-project-key: SonarCloud project key. (default: '')
583 :sonarcloud-project-organization: SonarCloud project organization.
585 :sonarcloud-api-token-cred-id: Jenkins credential ID which has the SonarCloud API Token.
586 This one SHOULDN'T be overwritten as we are standarizing the credential ID for all
587 projects (default: 'sonarcloud-api-token')
588 :sonarcloud-java-version: Version of Java to use for the Sonar scan. (default: openjdk11)
589 :stream: Keyword that represents a release code-name.
590 Often the same as the branch. (default: master)
591 :submodule-recursive: Whether to checkout submodules recursively.
593 :submodule-timeout: Timeout (in minutes) for checkout operation.
595 :submodule-disable: Disable submodule checkout operation.
597 :scan-dev-branch: Run the scan on a developer branch.
600 :gerrit_sonar_triggers: Override Gerrit Triggers.
605 .. literalinclude:: ../../.jjb-test/lf-maven-jobs/maven-sonarcloud.yaml
611 Sonar job which runs mvn clean install then publishes to Sonar.
613 This job runs on dev branches and its triggered on new patchsets.
617 - {project-name}-sonar-verify
618 - gerrit-maven-sonar-verify
620 :Comment Trigger: recheck|reverify
622 :Required parameters:
624 :build-node: The node to run build on.
625 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
626 :mvn-settings: The name of settings file containing credentials for the project.
628 :Optional parameters:
630 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
631 :build-timeout: Timeout in minutes before aborting build. (default: 60)
632 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
633 :java-version: Version of Java to use for the Maven build. (default: openjdk11)
634 :mvn-global-settings: The name of the Maven global settings to use for
635 Maven configuration. (default: global-settings)
636 :mvn-goals: The maven goals to perform for the build.
637 (default: clean install)
638 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
639 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
640 :mvn-version: Version of maven to use. (default: mvn35)
641 :pre-build-script: Shell script to run before maven build. (default: a string with a shell comment)
642 :post-build-script: Shell script to run after maven build. (default: a string with a shell comment)
643 :sonar-mvn-goal: Maven goals to run for sonar analysis.
644 (default: sonar:sonar)
645 :sonarcloud: Set to ``true`` to use SonarCloud ``true|false``.
647 :sonarcloud-project-key: SonarCloud project key. (default: '')
648 :sonarcloud-project-organization: SonarCloud project organization.
650 :sonarcloud-api-token-cred-id: Jenkins credential ID which has the SonarCloud API Token.
651 This one SHOULDN'T be overwritten as we are standarizing the credential ID for all
652 projects (default: 'sonarcloud-api-token')
653 :sonarcloud-java-version: Version of Java to use for the Sonar scan. (default: openjdk11)
654 :sonarcloud-qualitygate-wait: SonarCloud flag that forces the analysis step to
655 wait for the quality gate result. (default: false)
656 :stream: Keyword that represents a release code-name.
657 Often the same as the branch. (default: master)
658 :submodule-recursive: Whether to checkout submodules recursively.
660 :submodule-timeout: Timeout (in minutes) for checkout operation.
662 :submodule-disable: Disable submodule checkout operation.
664 :scan-dev-branch: Run the scan on a developer branch.
667 :gerrit_sonar_triggers: Override Gerrit Triggers.
672 .. literalinclude:: ../../.jjb-test/lf-maven-jobs/maven-sonarcloud.yaml
678 Verify job which runs mvn clean install to test a project build..
682 - {project-name}-maven-verify-{stream}-{mvn-version}-{java-version}
683 - gerrit-maven-verify
684 - github-maven-verify
686 :Comment Trigger: recheck|reverify
688 :Required parameters:
690 :build-node: The node to run build on.
691 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
692 :mvn-settings: The name of settings file containing credentials for the project.
694 :Optional parameters:
696 :branch: Git branch to fetch for the build. (default: master)
697 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
698 :build-timeout: Timeout in minutes before aborting build. (default: 60)
699 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
700 :java-version: Version of Java to use for the build. (default: openjdk11)
701 :mvn-global-settings: The name of the Maven global settings to use for
702 Maven configuration. (default: global-settings)
703 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
704 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
705 :mvn-version: Version of maven to use. (default: mvn35)
706 :stream: Keyword that represents a release code-name.
707 Often the same as the branch. (default: master)
708 :submodule-recursive: Whether to checkout submodules recursively.
710 :submodule-timeout: Timeout (in minutes) for checkout operation.
712 :submodule-disable: Disable submodule checkout operation.
715 :gerrit_verify_triggers: Override Gerrit Triggers.
716 :gerrit_trigger_file_paths: Override file paths to filter which file
717 modifications will trigger a build.
719 Maven Verify for Docker
720 -----------------------
722 Like the Maven Verify job as described above but logs in to Docker
723 registries first. The project POM file should invoke a plugin to build
724 a Docker image. This pulls the base image from the registry in the environment
725 variable ``CONTAINER_PULL_REGISTRY``.
729 - {project-name}-maven-docker-verify-{stream}-{mvn-version}-{java-version}
730 - gerrit-maven-docker-verify
731 - github-maven-docker-verify
733 :Required parameters:
735 :container-public-registry: Docker registry source with base images.
737 All other required and optional parameters are identical to the Maven Verify job
740 Maven Verify w/ Dependencies
741 ----------------------------
743 Verify job which runs mvn clean install to test a project build /w deps
745 This job's purpose is to verify a patch in conjunction to a list of upstream
746 patches it depends on. The user of this job can provide a list of patches via
751 - {project-name}-maven-verify-deps-{stream}-{mvn-version}-{java-version}
752 - gerrit-maven-verify-dependencies
754 :Comment Trigger: recheck: SPACE_SEPARATED_LIST_OF_PATCHES
756 :Required parameters:
758 :build-node: The node to run build on.
759 :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
760 :mvn-settings: The name of settings file containing credentials for the project.
762 :Optional parameters:
764 :branch: Git branch to fetch for the build. (default: master)
765 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
766 :build-timeout: Timeout in minutes before aborting build. (default: 60)
767 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
768 :java-version: Version of Java to use for the build. (default: openjdk11)
769 :mvn-global-settings: The name of the Maven global settings to use for
770 Maven configuration. (default: global-settings)
771 :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
772 :mvn-params: Parameters to pass to the mvn CLI. (default: '')
773 :mvn-version: Version of maven to use. (default: mvn35)
774 :stream: Keyword that represents a release code-name.
775 Often the same as the branch. (default: master)
776 :submodule-recursive: Whether to checkout submodules recursively.
778 :submodule-timeout: Timeout (in minutes) for checkout operation.
780 :submodule-disable: Disable submodule checkout operation.
783 :gerrit_verify_triggers: Override Gerrit Triggers.
784 :gerrit_trigger_file_paths: Override file paths to filter which file
785 modifications will trigger a build.