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 # staging-profile-id: Profile ID of the project's Nexus staging profile.
483 # Optional parameters:
484 # :gerrit_verify_triggers: Override Gerrit Triggers.
485 # :mvn-global-settings: The name of the Maven global settings to use for
486 # Maven configuration. (default: global-settings)
488 ######################
489 # Default parameters #
490 ######################
493 build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
495 git-url: '$GIT_URL/$PROJECT'
496 java-version: openjdk8
497 mvn-global-settings: global-settings
502 submodule-recursive: true
504 gerrit_release_triggers:
505 - comment-added-contains-event:
506 comment-contains-value: build release$
508 #####################
509 # Job Configuration #
510 #####################
513 - lf-jacoco-nojava-workaround
515 mvn-version: '{mvn-version}'
516 - lf-provide-maven-settings:
517 global-settings-file: '{mvn-global-settings}'
518 settings-file: '{mvn-settings}'
519 - lf-infra-create-netrc:
520 server-id: opendaylight-staging
521 - shell: !include-raw-escape:
522 - ../shell/lftools-install.sh
523 - ../shell/common-variables.sh
524 - ../shell/maven-patch-release.sh
525 - ../shell/maven-build.sh
526 - ../shell/maven-stage.sh
527 - lf-provide-maven-settings-cleanup
530 name: '{project-name}-maven-release-{stream}'
531 id: gerrit-maven-release
533 # yamllint disable-line rule:key-duplicates
534 <<: *lf_maven_release
537 - lf-infra-gerrit-scm:
538 jenkins-ssh-credential: '{jenkins-ssh-credential}'
540 refspec: '$GERRIT_REFSPEC'
541 branch: '$GERRIT_BRANCH'
542 submodule-recursive: '{submodule-recursive}'
543 choosing-strategy: default
547 server-name: '{gerrit-server-name}'
548 trigger-on: '{obj:gerrit_release_triggers}'
550 - project-compare-type: ANT
551 project-pattern: '{project}'
553 - branch-compare-type: ANT
554 branch-pattern: '**/{branch}'
557 name: '{project-name}-maven-release-{stream}'
558 id: github-maven-release
560 # yamllint disable-line rule:key-duplicates
561 <<: *lf_maven_release
565 url: '{git-url}/{github-org}/{project}'
568 - lf-infra-github-scm:
569 url: '{git-clone-url}{github-org}/{project}'
570 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
572 submodule-recursive: '{submodule-recursive}'
573 choosing-strategy: default
574 jenkins-ssh-credential: '{jenkins-ssh-credential}'
577 - lf-infra-github-pr-trigger:
578 trigger-phrase: '^build release$'
579 only-trigger-phrase: true
580 status-context: 'Maven Release'
586 github_pr_admin_list:
593 - lf_maven_sonar: &lf_maven_sonar
596 # Sonar job which runs mvn clean install then publishes to Sonar.
598 # This job purposely only runs on the master branch as there are Additional
599 # configuration needed to support multiple branches and there's not much
600 # interest in that kind of support.
602 # Required parameters:
604 # :build-node: The node to run build on.
605 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
606 # be configured in defaults.yaml)
607 # :mvn-settings: The name of settings file containing credentials for
610 # Optional parameters:
612 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
613 # :build-timeout: Timeout in seconds before aborting build. (default: 60)
614 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
615 # :java-version: Version of Java to use for the build. (default: openjdk8)
616 # :mvn-global-settings: The name of the Maven global settings to use for
617 # Maven configuration. (default: global-settings)
618 # :mvn-opts: Sets MAVEN_OPTS. (default: '')
619 # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
620 # :mvn-version: Version of maven to use. (default: mvn33)
621 # :submodule-recursive: Whether to checkout submodules recursively.
624 # :gerrit_sonar_triggers: Override Gerrit Triggers.
626 ######################
627 # Default parameters #
628 ######################
630 branch: master # Sonar should always be run on master branch
631 build-days-to-keep: 7
633 git-url: '$GIT_URL/$PROJECT'
634 java-version: openjdk8
635 mvn-global-settings: global-settings
640 submodule-recursive: true
642 gerrit_sonar_triggers:
643 - comment-added-contains-event:
644 comment-contains-value: run-sonar$
646 # Staging repos do not make sense for CLM jobs so set it blank.
647 staging-profile-id: ''
649 #####################
650 # Job Configuration #
651 #####################
656 server-name: '{gerrit-server-name}'
657 trigger-on: '{obj:gerrit_sonar_triggers}'
659 - project-compare-type: 'ANT'
660 project-pattern: '{project}'
662 - branch-compare-type: 'ANT'
663 branch-pattern: '**/master'
671 - lf-infra-maven-sonar:
672 mvn-settings: '{mvn-settings}'
673 mvn-version: '{mvn-version}'
681 name: lf-infra-maven-sonar
682 # Run a Sonar build with Maven
685 mvn-version: '{mvn-version}'
687 # Switch this to the sonar wrapper when JJB 2.0 is available
688 properties-content: |
689 SONAR_HOST_URL=$SONAR_URL
690 SONAR_MAVEN_GOAL=sonar:sonar
691 - lf-provide-maven-settings:
692 global-settings-file: global-settings
693 settings-file: '{mvn-settings}'
694 - shell: !include-raw-escape:
695 - ../shell/common-variables.sh
696 - ../shell/maven-sonar.sh
697 - lf-provide-maven-settings-cleanup
700 name: '{project-name}-sonar'
701 id: gerrit-maven-sonar
703 # yamllint disable-line rule:key-duplicates
707 - lf-infra-gerrit-scm:
708 jenkins-ssh-credential: '{jenkins-ssh-credential}'
710 refspec: $GERRIT_REFSPEC
711 branch: $GERRIT_BRANCH
712 submodule-recursive: '{submodule-recursive}'
713 choosing-strategy: default
716 name: '{project-name}-sonar'
717 id: github-maven-sonar
719 # yamllint disable-line rule:key-duplicates
724 url: '{git-url}/{github-org}/{project}'
727 - lf-infra-github-scm:
728 url: '{git-clone-url}{github-org}/{project}'
729 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
731 submodule-recursive: '{submodule-recursive}'
732 choosing-strategy: default
733 jenkins-ssh-credential: '{jenkins-ssh-credential}'
736 - lf-infra-github-pr-trigger:
737 trigger-phrase: '^recheck$'
738 only-trigger-phrase: false
739 status-context: 'Maven Verify'
745 github_pr_admin_list:
752 - lf_maven_verify: &lf_maven_verify
753 name: lf-maven-verify
755 # Verify job which runs mvn clean install to test a project build..
757 # Required parameters:
759 # :build-node: The node to run build on.
760 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
761 # be configured in defaults.yaml)
762 # :mvn-settings: The name of settings file containing credentials for
765 # Optional parameters:
767 # :branch: Git branch to fetch for the build. (default: master)
768 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
769 # :build-timeout: Timeout in seconds before aborting build. (default: 60)
770 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
771 # :java-version: Version of Java to use for the build. (default: openjdk8)
772 # :mvn-global-settings: The name of the Maven global settings to use for
773 # Maven configuration. (default: global-settings)
774 # :mvn-opts: Sets MAVEN_OPTS. (default: '')
775 # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
776 # :mvn-version: Version of maven to use. (default: mvn33)
777 # :stream: Keyword that can be used to represent a release code-name.
778 # Often the same as the branch. (default: master)
779 # :submodule-recursive: Whether to checkout submodules recursively.
782 # :gerrit_verify_triggers: Override Gerrit Triggers.
783 # :gerrit_trigger_file_paths: Override file paths which can be used to
784 # filter which file modifications will trigger a build.
786 ######################
787 # Default parameters #
788 ######################
791 build-days-to-keep: 7
793 git-url: '$GIT_URL/$PROJECT'
794 java-version: openjdk8
795 mvn-global-settings: global-settings
797 mvn-params: '-Dstream=$STREAM'
800 submodule-recursive: true
802 gerrit_verify_triggers:
803 - patchset-created-event:
804 exclude-drafts: false
805 exclude-trivial-rebase: false
806 exclude-no-code-change: false
807 - draft-published-event
808 - comment-added-contains-event:
809 comment-contains-value: recheck$
810 gerrit_trigger_file_paths:
814 #####################
815 # Job Configuration #
816 #####################
821 - lf-jacoco-nojava-workaround
823 mvn-version: '{mvn-version}'
824 - lf-provide-maven-settings:
825 global-settings-file: '{mvn-global-settings}'
826 settings-file: '{mvn-settings}'
827 - shell: !include-raw-escape:
828 - ../shell/lftools-install.sh
829 - ../shell/common-variables.sh
830 - ../shell/maven-build.sh
831 - lf-provide-maven-settings-cleanup
839 name: '{project-name}-maven-verify-{stream}-{mvn-version}-{java-version}'
840 id: gerrit-maven-verify
842 # yamllint disable-line rule:key-duplicates
846 - lf-infra-gerrit-scm:
847 jenkins-ssh-credential: '{jenkins-ssh-credential}'
849 refspec: '$GERRIT_REFSPEC'
850 branch: '$GERRIT_BRANCH'
851 submodule-recursive: '{submodule-recursive}'
852 choosing-strategy: gerrit
856 server-name: '{gerrit-server-name}'
857 trigger-on: '{obj:gerrit_verify_triggers}'
859 - project-compare-type: ANT
860 project-pattern: '{project}'
862 - branch-compare-type: ANT
863 branch-pattern: '**/{branch}'
864 file-paths: '{obj:gerrit_trigger_file_paths}'
867 name: '{project-name}-maven-verify-{stream}-{mvn-version}-{java-version}'
868 id: github-maven-verify
870 # yamllint disable-line rule:key-duplicates
875 url: '{git-url}/{github-org}/{project}'
878 - lf-infra-github-scm:
879 url: '{git-clone-url}{github-org}/{project}'
880 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
882 submodule-recursive: '{submodule-recursive}'
883 choosing-strategy: default
884 jenkins-ssh-credential: '{jenkins-ssh-credential}'
887 - lf-infra-github-pr-trigger:
888 trigger-phrase: '^recheck$'
889 only-trigger-phrase: false
890 status-context: 'Maven Verify'
896 github_pr_admin_list: