2 # This file contains job templates for Maven projects.
5 name: '{project-name}-maven-jobs'
7 # This job group contains all the recommended jobs that should be deployed
12 - gerrit-maven-release
16 name: '{project-name}-github-maven-jobs'
18 # This job group contains all the recommended jobs that should be deployed
19 # for any project ci that is using github.
23 - github-maven-release
27 name: '{project-name}-maven-javadoc-jobs'
29 # This job group contains all the recommended jobs that should be deployed
33 - gerrit-maven-javadoc-publish
34 - gerrit-maven-javadoc-verify
37 name: '{project-name}-github-maven-javadoc-jobs'
39 # This job group contains all the recommended jobs that should be deployed
43 - github-maven-javadoc-publish
44 - github-maven-javadoc-verify
50 - lf_maven_common: &lf_maven_common
53 project-type: freestyle
58 - lf-infra-properties:
59 build-days-to-keep: '{build-days-to-keep}'
62 - lf-infra-parameters:
66 lftools-version: '{lftools-version}'
67 - lf-infra-maven-parameters:
68 mvn-opts: '{mvn-opts}'
69 mvn-params: '{mvn-params}'
70 mvn-version: '{mvn-version}'
71 # Staging repos do not make sense for CLM jobs so set it blank.
72 staging-profile-id: '{staging-profile-id}'
76 build-timeout: '{build-timeout}'
77 jenkins-ssh-credential: '{jenkins-ssh-credential}'
80 # TODO: Make email notification work.
81 # - lf-infra-email-notify:
82 # email-recipients: '{email-recipients}'
83 # email-prefix: '[releng]'
90 - lf_maven_clm: &lf_maven_clm
93 # Produces a CLM scan of the code into Nexus IQ Server.
95 # Required parameters:
96 # build-node: The node to run build on.
97 # jenkins-ssh-credential: Credential to use for SSH. (Generally should
98 # be configured in defaults.yaml)
99 # mvn-settings: The name of settings file containing credentials for
102 # Optional parameters:
103 # mvn-global-settings: The name of the Maven global settings to use for
104 # Maven configuration. (default: global-settings)
106 ######################
107 # Default parameters #
108 ######################
111 build-days-to-keep: 30 # 30 days for troubleshooting purposes
113 git-url: '$GIT_URL/$PROJECT'
114 java-version: openjdk8
115 mvn-global-settings: global-settings
120 submodule-recursive: true
122 # Staging repos do not make sense for CLM jobs so set it blank.
123 staging-profile-id: ''
125 #####################
126 # Job Configuration #
127 #####################
130 # Build weekly on Saturdays
135 mvn-version: '{mvn-version}'
136 - lf-provide-maven-settings:
137 global-settings-file: '{mvn-global-settings}'
138 settings-file: '{mvn-settings}'
139 - shell: !include-raw-escape:
140 - ../shell/common-variables.sh
141 - ../shell/sonatype-clm.sh
142 - lf-provide-maven-settings-cleanup
143 - shell: 'find . -regex ".*karaf/target" | xargs rm -rf'
145 application-name: '{project-name}'
148 name: '{project-name}-maven-clm-{stream}'
151 # yamllint disable-line rule:key-duplicates
155 - lf-infra-gerrit-scm:
156 jenkins-ssh-credential: '{jenkins-ssh-credential}'
158 refspec: '$GERRIT_REFSPEC'
159 branch: '$GERRIT_BRANCH'
160 submodule-recursive: '{submodule-recursive}'
161 choosing-strategy: default
164 name: '{project-name}-maven-clm-{stream}'
167 # yamllint disable-line rule:key-duplicates
172 url: '{git-url}/{github-org}/{project}'
175 - lf-infra-github-scm:
176 url: '{git-clone-url}{github-org}/{project}'
177 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
179 submodule-recursive: '{submodule-recursive}'
180 choosing-strategy: default
181 jenkins-ssh-credential: '{jenkins-ssh-credential}'
183 #########################
184 # Maven Javadoc Publish #
185 #########################
187 - lf_maven_javadoc_publish: &lf_maven_javadoc_publish
188 name: lf-maven-javadoc-publish
190 # Produces and publishes javadocs for a Maven project.
192 # Expects javadocs to be available in $WORKSPACE/target/site/apidocs
194 # Required parameters:
196 # :build-node: The node to run build on.
197 # :javadoc-path: The path in Nexus to deploy javadoc to.
198 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
199 # be configured in defaults.yaml)
200 # :mvn-settings: The name of settings file containing credentials for
202 # :mvn-site-id: Maven Server ID from settings.xml to pull credentials from.
203 # (Note: This setting should be configured in defaults.yaml.)
205 # Optional parameters:
207 # :branch: The branch to build against. (default: master)
208 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
209 # :build-timeout: Timeout in seconds before aborting build. (default: 60)
210 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
211 # :java-version: Version of Java to use for the build. (default: openjdk8)
212 # :mvn-global-settings: The name of the Maven global settings to use for
213 # Maven configuration. (default: global-settings)
214 # :mvn-opts: Sets MAVEN_OPTS. (default: '')
215 # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
216 # :mvn-version: Version of maven to use. (default: mvn33)
217 # :submodule-recursive: Whether to checkout submodules recursively.
220 # :gerrit_javadoc_merge_triggers: Override Gerrit Triggers.
222 ######################
223 # Default parameters #
224 ######################
227 build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
229 git-url: '$GIT_URL/$PROJECT'
230 java-version: openjdk8
231 mvn-global-settings: global-settings
236 submodule-recursive: true
238 gerrit_javadoc_merge_triggers:
239 - change-merged-event
240 - comment-added-contains-event:
241 comment-contains-value: remerge$
243 #####################
244 # Job Configuration #
245 #####################
249 mvn-version: '{mvn-version}'
250 - lf-provide-maven-settings:
251 global-settings-file: '{mvn-global-settings}'
252 settings-file: '{mvn-settings}'
253 - lf-infra-create-netrc:
254 server-id: '{mvn-site-id}'
256 properties-content: 'DEPLOY_PATH={javadoc-path}'
257 - shell: !include-raw-escape:
258 - ../shell/common-variables.sh
259 - ../shell/maven-javadoc-generate.sh
260 - ../shell/lftools-install.sh
261 - ../shell/maven-javadoc-publish.sh
262 - lf-provide-maven-settings-cleanup
265 name: '{project-name}-maven-javadoc-publish-{stream}'
266 id: gerrit-maven-javadoc-publish
268 # yamllint disable-line rule:key-duplicates
269 <<: *lf_maven_javadoc_publish
271 git-url: '$GIT_URL/$GERRIT_PROJECT'
274 - lf-infra-gerrit-scm:
278 submodule-recursive: '{submodule-recursive}'
279 choosing-strategy: default
280 jenkins-ssh-credential: '{jenkins-ssh-credential}'
284 server-name: '{gerrit-server-name}'
285 trigger-on: '{obj:gerrit_javadoc_merge_triggers}'
287 - project-compare-type: ANT
288 project-pattern: '{project}'
290 - branch-compare-type: ANT
291 branch-pattern: '**/{branch}'
294 name: '{project-name}-maven-javadoc-publish-{stream}'
295 id: github-maven-javadoc-publish
297 # yamllint disable-line rule:key-duplicates
298 <<: *lf_maven_javadoc_publish
302 url: '{git-url}/{github-org}/{project}'
305 - lf-infra-github-scm:
306 url: '{git-clone-url}{github-org}/{project}'
309 submodule-recursive: '{submodule-recursive}'
310 choosing-strategy: default
311 jenkins-ssh-credential: '{jenkins-ssh-credential}'
317 - lf-infra-github-pr-trigger:
318 trigger-phrase: '^remerge$'
319 only-trigger-phrase: true
320 status-context: 'JJB Merge'
323 github-org: '{github-org}'
324 github_pr_whitelist: '{obj:github_pr_whitelist}'
325 github_pr_admin_list: '{obj:github_pr_admin_list}'
327 ########################
328 # Maven Javadoc Verify #
329 ########################
331 - lf_maven_javadoc_verify: &lf_maven_javadoc_verify
332 name: lf-maven-javadoc-verify
334 # Produces javadocs for a Maven project.
336 # Expects javadocs to be available in $WORKSPACE/target/site/apidocs
338 # Required parameters:
339 # build-node: The node to run build on.
340 # jenkins-ssh-credential: Credential to use for SSH. (Generally should
341 # be configured in defaults.yaml)
342 # mvn-settings: The name of settings file containing credentials for
345 # Optional parameters:
347 # :branch: The branch to build against. (default: master)
348 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
349 # :build-timeout: Timeout in seconds before aborting build. (default: 60)
350 # :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
351 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
352 # :java-version: Version of Java to use for the build. (default: openjdk8)
353 # :mvn-global-settings: The name of the Maven global settings to use for
354 # Maven configuration. (default: global-settings)
355 # :mvn-opts: Sets MAVEN_OPTS. (default: '')
356 # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
357 # :mvn-version: Version of maven to use. (default: mvn33)
358 # :submodule-recursive: Whether to checkout submodules recursively.
361 # :gerrit_javadoc_verify_triggers: Override Gerrit Triggers.
363 ######################
364 # Default parameters #
365 ######################
368 build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
370 git-url: '$GIT_URL/$PROJECT'
371 java-version: openjdk8
372 mvn-global-settings: global-settings
377 submodule-recursive: true
379 gerrit_javadoc_verify_triggers:
380 - patchset-created-event:
381 exclude-drafts: false
382 exclude-trivial-rebase: false
383 exclude-no-code-change: false
384 - draft-published-event
385 - comment-added-contains-event:
386 comment-contains-value: recheck$
388 #####################
389 # Job Configuration #
390 #####################
394 mvn-version: '{mvn-version}'
395 - lf-provide-maven-settings:
396 global-settings-file: '{mvn-global-settings}'
397 settings-file: '{mvn-settings}'
398 - shell: !include-raw-escape:
399 - ../shell/common-variables.sh
400 - ../shell/maven-javadoc-generate.sh
401 - lf-provide-maven-settings-cleanup
404 name: '{project-name}-maven-javadoc-verify-{stream}'
405 id: gerrit-maven-javadoc-verify
407 # yamllint disable-line rule:key-duplicates
408 <<: *lf_maven_javadoc_verify
411 - lf-infra-gerrit-scm:
412 jenkins-ssh-credential: '{jenkins-ssh-credential}'
414 refspec: '$GERRIT_REFSPEC'
415 branch: '$GERRIT_BRANCH'
416 submodule-recursive: '{submodule-recursive}'
417 choosing-strategy: gerrit
421 server-name: '{gerrit-server-name}'
422 trigger-on: '{obj:gerrit_javadoc_verify_triggers}'
424 - project-compare-type: ANT
425 project-pattern: '{project}'
427 - branch-compare-type: ANT
428 branch-pattern: '**/{branch}'
431 name: '{project-name}-maven-javadoc-verify-{stream}'
432 id: github-maven-javadoc-verify
434 # yamllint disable-line rule:key-duplicates
435 <<: *lf_maven_javadoc_verify
439 url: '{git-url}/{github-org}/{project}'
442 - lf-infra-github-scm:
443 url: '{git-clone-url}{github-org}/{project}'
444 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
446 submodule-recursive: '{submodule-recursive}'
447 choosing-strategy: default
448 jenkins-ssh-credential: '{jenkins-ssh-credential}'
451 - lf-infra-github-pr-trigger:
452 trigger-phrase: '^recheck$'
453 only-trigger-phrase: true
454 status-context: 'Maven Javadoc'
460 github_pr_admin_list:
467 - lf_maven_release: &lf_maven_release
468 name: lf-maven-release
470 # Produces a release candidate by creating a staging repo in Nexus.
472 # Runs a Maven build and deploys to $WORKSPACE/m2repo directory. This
473 # directory can then be reused later to deploy to Nexus.
475 # Required parameters:
476 # :build-node: The node to run build on.
477 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
478 # be configured in defaults.yaml)
479 # :mvn-settings: The name of settings file containing credentials for
481 # :mvn-staging-id: Maven Server ID from settings.xml to pull credentials from.
482 # (Note: This setting should be configured in defaults.yaml.)
483 # :staging-profile-id: Profile ID of the project's Nexus staging profile.
485 # Optional parameters:
486 # :gerrit_verify_triggers: Override Gerrit Triggers.
487 # :mvn-global-settings: The name of the Maven global settings to use for
488 # Maven configuration. (default: global-settings)
489 # :cron: Cron schedule when to trigger the job. This parameter also
490 # supports multiline input via YAML pipe | character in cases where
491 # one may want to provide more than 1 cron timer. (default: '')
493 ######################
494 # Default parameters #
495 ######################
498 build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
500 git-url: '$GIT_URL/$PROJECT'
501 java-version: openjdk8
502 mvn-global-settings: global-settings
507 submodule-recursive: true
510 gerrit_release_triggers:
511 - comment-added-contains-event:
512 comment-contains-value: build release$
514 #####################
515 # Job Configuration #
516 #####################
519 - lf-jacoco-nojava-workaround
521 mvn-version: '{mvn-version}'
522 - lf-provide-maven-settings:
523 global-settings-file: '{mvn-global-settings}'
524 settings-file: '{mvn-settings}'
525 - lf-infra-create-netrc:
526 server-id: '{mvn-staging-id}'
527 - shell: !include-raw-escape:
528 - ../shell/lftools-install.sh
529 - ../shell/common-variables.sh
530 - ../shell/maven-patch-release.sh
531 - ../shell/maven-build.sh
532 - ../shell/maven-stage.sh
533 - lf-provide-maven-settings-cleanup
536 name: '{project-name}-maven-release-{stream}'
537 id: gerrit-maven-release
539 # yamllint disable-line rule:key-duplicates
540 <<: *lf_maven_release
543 - lf-infra-gerrit-scm:
544 jenkins-ssh-credential: '{jenkins-ssh-credential}'
546 refspec: '$GERRIT_REFSPEC'
547 branch: '$GERRIT_BRANCH'
548 submodule-recursive: '{submodule-recursive}'
549 choosing-strategy: default
552 - timed: '{obj:cron}'
554 server-name: '{gerrit-server-name}'
555 trigger-on: '{obj:gerrit_release_triggers}'
557 - project-compare-type: ANT
558 project-pattern: '{project}'
560 - branch-compare-type: ANT
561 branch-pattern: '**/{branch}'
564 name: '{project-name}-maven-release-{stream}'
565 id: github-maven-release
567 # yamllint disable-line rule:key-duplicates
568 <<: *lf_maven_release
572 url: '{git-url}/{github-org}/{project}'
575 - lf-infra-github-scm:
576 url: '{git-clone-url}{github-org}/{project}'
577 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
579 submodule-recursive: '{submodule-recursive}'
580 choosing-strategy: default
581 jenkins-ssh-credential: '{jenkins-ssh-credential}'
584 - timed: '{obj:cron}'
585 - lf-infra-github-pr-trigger:
586 trigger-phrase: '^build release$'
587 only-trigger-phrase: true
588 status-context: 'Maven Release'
594 github_pr_admin_list:
601 - lf_maven_sonar: &lf_maven_sonar
604 # Sonar job which runs mvn clean install then publishes to Sonar.
606 # This job purposely only runs on the master branch as there are Additional
607 # configuration needed to support multiple branches and there's not much
608 # interest in that kind of support.
610 # Required parameters:
612 # :build-node: The node to run build on.
613 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
614 # be configured in defaults.yaml)
615 # :mvn-settings: The name of settings file containing credentials for
618 # Optional parameters:
620 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
621 # :build-timeout: Timeout in seconds before aborting build. (default: 60)
622 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
623 # :java-version: Version of Java to use for the build. (default: openjdk8)
624 # :mvn-global-settings: The name of the Maven global settings to use for
625 # Maven configuration. (default: global-settings)
626 # :mvn-opts: Sets MAVEN_OPTS. (default: '')
627 # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
628 # :mvn-version: Version of maven to use. (default: mvn33)
629 # :submodule-recursive: Whether to checkout submodules recursively.
632 # :gerrit_sonar_triggers: Override Gerrit Triggers.
634 ######################
635 # Default parameters #
636 ######################
638 branch: master # Sonar should always be run on master branch
639 build-days-to-keep: 7
641 git-url: '$GIT_URL/$PROJECT'
642 java-version: openjdk8
643 mvn-global-settings: global-settings
648 submodule-recursive: true
650 gerrit_sonar_triggers:
651 - comment-added-contains-event:
652 comment-contains-value: run-sonar$
654 # Staging repos do not make sense for CLM jobs so set it blank.
655 staging-profile-id: ''
657 #####################
658 # Job Configuration #
659 #####################
664 server-name: '{gerrit-server-name}'
665 trigger-on: '{obj:gerrit_sonar_triggers}'
667 - project-compare-type: 'ANT'
668 project-pattern: '{project}'
670 - branch-compare-type: 'ANT'
671 branch-pattern: '**/master'
679 - lf-infra-maven-sonar:
680 mvn-settings: '{mvn-settings}'
681 mvn-version: '{mvn-version}'
689 name: lf-infra-maven-sonar
690 # Run a Sonar build with Maven
693 mvn-version: '{mvn-version}'
695 # Switch this to the sonar wrapper when JJB 2.0 is available
696 properties-content: |
697 SONAR_HOST_URL=$SONAR_URL
698 SONAR_MAVEN_GOAL=sonar:sonar
699 - lf-provide-maven-settings:
700 global-settings-file: global-settings
701 settings-file: '{mvn-settings}'
702 - shell: !include-raw-escape:
703 - ../shell/common-variables.sh
704 - ../shell/maven-sonar.sh
705 - lf-provide-maven-settings-cleanup
708 name: '{project-name}-sonar'
709 id: gerrit-maven-sonar
711 # yamllint disable-line rule:key-duplicates
715 - lf-infra-gerrit-scm:
716 jenkins-ssh-credential: '{jenkins-ssh-credential}'
718 refspec: $GERRIT_REFSPEC
719 branch: $GERRIT_BRANCH
720 submodule-recursive: '{submodule-recursive}'
721 choosing-strategy: default
724 name: '{project-name}-sonar'
725 id: github-maven-sonar
727 # yamllint disable-line rule:key-duplicates
732 url: '{git-url}/{github-org}/{project}'
735 - lf-infra-github-scm:
736 url: '{git-clone-url}{github-org}/{project}'
737 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
739 submodule-recursive: '{submodule-recursive}'
740 choosing-strategy: default
741 jenkins-ssh-credential: '{jenkins-ssh-credential}'
744 - lf-infra-github-pr-trigger:
745 trigger-phrase: '^recheck$'
746 only-trigger-phrase: false
747 status-context: 'Maven Verify'
753 github_pr_admin_list:
760 - lf_maven_verify: &lf_maven_verify
761 name: lf-maven-verify
763 # Verify job which runs mvn clean install to test a project build..
765 # Required parameters:
767 # :build-node: The node to run build on.
768 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
769 # be configured in defaults.yaml)
770 # :mvn-settings: The name of settings file containing credentials for
773 # Optional parameters:
775 # :branch: Git branch to fetch for the build. (default: master)
776 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
777 # :build-timeout: Timeout in seconds before aborting build. (default: 60)
778 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
779 # :java-version: Version of Java to use for the build. (default: openjdk8)
780 # :mvn-global-settings: The name of the Maven global settings to use for
781 # Maven configuration. (default: global-settings)
782 # :mvn-opts: Sets MAVEN_OPTS. (default: '')
783 # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
784 # :mvn-version: Version of maven to use. (default: mvn33)
785 # :stream: Keyword that can be used to represent a release code-name.
786 # Often the same as the branch. (default: master)
787 # :submodule-recursive: Whether to checkout submodules recursively.
790 # :gerrit_verify_triggers: Override Gerrit Triggers.
791 # :gerrit_trigger_file_paths: Override file paths which can be used to
792 # filter which file modifications will trigger a build.
794 ######################
795 # Default parameters #
796 ######################
799 build-days-to-keep: 7
801 git-url: '$GIT_URL/$PROJECT'
802 java-version: openjdk8
803 mvn-global-settings: global-settings
805 mvn-params: '-Dstream=$STREAM'
808 submodule-recursive: true
810 gerrit_verify_triggers:
811 - patchset-created-event:
812 exclude-drafts: false
813 exclude-trivial-rebase: false
814 exclude-no-code-change: false
815 - draft-published-event
816 - comment-added-contains-event:
817 comment-contains-value: recheck$
818 gerrit_trigger_file_paths:
822 #####################
823 # Job Configuration #
824 #####################
829 - lf-jacoco-nojava-workaround
831 mvn-version: '{mvn-version}'
832 - lf-provide-maven-settings:
833 global-settings-file: '{mvn-global-settings}'
834 settings-file: '{mvn-settings}'
835 - shell: !include-raw-escape:
836 - ../shell/lftools-install.sh
837 - ../shell/common-variables.sh
838 - ../shell/maven-build.sh
839 - lf-provide-maven-settings-cleanup
847 name: '{project-name}-maven-verify-{stream}-{mvn-version}-{java-version}'
848 id: gerrit-maven-verify
850 # yamllint disable-line rule:key-duplicates
854 - lf-infra-gerrit-scm:
855 jenkins-ssh-credential: '{jenkins-ssh-credential}'
857 refspec: '$GERRIT_REFSPEC'
858 branch: '$GERRIT_BRANCH'
859 submodule-recursive: '{submodule-recursive}'
860 choosing-strategy: gerrit
864 server-name: '{gerrit-server-name}'
865 trigger-on: '{obj:gerrit_verify_triggers}'
867 - project-compare-type: ANT
868 project-pattern: '{project}'
870 - branch-compare-type: ANT
871 branch-pattern: '**/{branch}'
872 file-paths: '{obj:gerrit_trigger_file_paths}'
875 name: '{project-name}-maven-verify-{stream}-{mvn-version}-{java-version}'
876 id: github-maven-verify
878 # yamllint disable-line rule:key-duplicates
883 url: '{git-url}/{github-org}/{project}'
886 - lf-infra-github-scm:
887 url: '{git-clone-url}{github-org}/{project}'
888 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
890 submodule-recursive: '{submodule-recursive}'
891 choosing-strategy: default
892 jenkins-ssh-credential: '{jenkins-ssh-credential}'
895 - lf-infra-github-pr-trigger:
896 trigger-phrase: '^recheck$'
897 only-trigger-phrase: false
898 status-context: 'Maven Verify'
904 github_pr_admin_list: