- gerrit-maven-clm
- gerrit-maven-release
- gerrit-maven-verify
+ - gerrit-maven-verify-dependencies
- job-group:
name: '{project-name}-github-maven-jobs'
- github-maven-release
- github-maven-verify
+- job-group:
+ name: '{project-name}-maven-javadoc-jobs'
+
+ # This job group contains all the recommended jobs that should be deployed
+ # for any project ci.
+
+ jobs:
+ - gerrit-maven-javadoc-publish
+ - gerrit-maven-javadoc-verify
+
+- job-group:
+ name: '{project-name}-github-maven-javadoc-jobs'
+
+ # This job group contains all the recommended jobs that should be deployed
+ # for any project ci.
+
+ jobs:
+ - github-maven-javadoc-publish
+ - github-maven-javadoc-verify
+
####################
# COMMON FUNCTIONS #
####################
# the project.
#
# Optional parameters:
- # mvn-global-settings: The name of the Maven global settings to use for
- # Maven configuration. (default: global-settings)
+ #
+ # :branch: The branch to build against. (default: master)
+ # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+ # :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ # :java-version: Version of Java to use for the build. (default: openjdk8)
+ # :mvn-global-settings: The name of the Maven global settings to use for
+ # Maven configuration. (default: global-settings)
+ # :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ # :mvn-version: Version of maven to use. (default: mvn33)
+ # :stream: Keyword that can be used to represent a release code-name.
+ # Often the same as the branch. (default: master)
+ # :submodule-recursive: Whether to checkout submodules recursively.
+ # (default: true)
+ #
+ # :gerrit_merge_triggers: Override Gerrit Triggers.
######################
# Default parameters #
mvn-opts: ''
mvn-params: ''
mvn-version: mvn33
+ staging-profile-id: '' # Unused in this job
stream: master
submodule-recursive: true
- # Staging repos do not make sense for CLM jobs so set it blank.
- staging-profile-id: ''
-
#####################
# Job Configuration #
#####################
choosing-strategy: default
jenkins-ssh-credential: '{jenkins-ssh-credential}'
+#########################
+# Maven Javadoc Publish #
+#########################
+
+- lf_maven_javadoc_publish: &lf_maven_javadoc_publish
+ name: lf-maven-javadoc-publish
+
+ # Produces and publishes javadocs for a Maven project.
+ #
+ # Expects javadocs to be available in $WORKSPACE/target/site/apidocs
+ #
+ # Required parameters:
+ #
+ # :build-node: The node to run build on.
+ # :javadoc-path: The path in Nexus to deploy javadoc to.
+ # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+ # be configured in defaults.yaml)
+ # :mvn-settings: The name of settings file containing credentials for
+ # the project.
+ # :mvn-site-id: Maven Server ID from settings.xml to pull credentials from.
+ # (Note: This setting should be configured in defaults.yaml.)
+ #
+ # Optional parameters:
+ #
+ # :branch: The branch to build against. (default: master)
+ # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+ # :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ # :java-version: Version of Java to use for the build. (default: openjdk8)
+ # :mvn-global-settings: The name of the Maven global settings to use for
+ # Maven configuration. (default: global-settings)
+ # :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ # :mvn-version: Version of maven to use. (default: mvn33)
+ # :stream: Keyword that can be used to represent a release code-name.
+ # Often the same as the branch. (default: master)
+ # :submodule-recursive: Whether to checkout submodules recursively.
+ # (default: true)
+ #
+ # :gerrit_merge_triggers: Override Gerrit Triggers.
+
+ ######################
+ # Default parameters #
+ ######################
+
+ branch: master
+ build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
+ build-timeout: 30
+ git-url: '$GIT_URL/$PROJECT'
+ java-version: openjdk8
+ mvn-global-settings: global-settings
+ mvn-opts: ''
+ mvn-params: ''
+ mvn-version: mvn33
+ staging-profile-id: '' # Unused by the javadoc jobs
+ stream: master
+ submodule-recursive: true
+
+ gerrit_merge_triggers:
+ - change-merged-event
+ - comment-added-contains-event:
+ comment-contains-value: remerge$
+
+ #####################
+ # Job Configuration #
+ #####################
+
+ builders:
+ - lf-maven-install:
+ mvn-version: '{mvn-version}'
+ - lf-provide-maven-settings:
+ global-settings-file: '{mvn-global-settings}'
+ settings-file: '{mvn-settings}'
+ - lf-infra-create-netrc:
+ server-id: '{mvn-site-id}'
+ - inject:
+ properties-content: 'DEPLOY_PATH={javadoc-path}'
+ - shell: !include-raw-escape:
+ - ../shell/common-variables.sh
+ - ../shell/maven-javadoc-generate.sh
+ - ../shell/lftools-install.sh
+ - ../shell/maven-javadoc-publish.sh
+ - lf-provide-maven-settings-cleanup
+
+- job-template:
+ name: '{project-name}-maven-javadoc-publish-{stream}'
+ id: gerrit-maven-javadoc-publish
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_javadoc_publish
+
+ git-url: '$GIT_URL/$GERRIT_PROJECT'
+
+ scm:
+ - lf-infra-gerrit-scm:
+ git-url: '{git-url}'
+ refspec: ''
+ branch: '{branch}'
+ submodule-recursive: '{submodule-recursive}'
+ choosing-strategy: default
+ jenkins-ssh-credential: '{jenkins-ssh-credential}'
+
+ triggers:
+ - gerrit:
+ server-name: '{gerrit-server-name}'
+ trigger-on: '{obj:gerrit_merge_triggers}'
+ projects:
+ - project-compare-type: ANT
+ project-pattern: '{project}'
+ branches:
+ - branch-compare-type: ANT
+ branch-pattern: '**/{branch}'
+
+- job-template:
+ name: '{project-name}-maven-javadoc-publish-{stream}'
+ id: github-maven-javadoc-publish
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_javadoc_publish
+
+ properties:
+ - github:
+ url: '{git-url}/{github-org}/{project}'
+
+ scm:
+ - lf-infra-github-scm:
+ url: '{git-clone-url}{github-org}/{project}'
+ refspec: ''
+ branch: '{branch}'
+ submodule-recursive: '{submodule-recursive}'
+ choosing-strategy: default
+ jenkins-ssh-credential: '{jenkins-ssh-credential}'
+
+ triggers:
+ - github
+ - pollscm:
+ cron: ''
+ - lf-infra-github-pr-trigger:
+ trigger-phrase: '^remerge$'
+ only-trigger-phrase: true
+ status-context: 'JJB Merge'
+ permit-all: false
+ github-hooks: true
+ github-org: '{github-org}'
+ github_pr_whitelist: '{obj:github_pr_whitelist}'
+ github_pr_admin_list: '{obj:github_pr_admin_list}'
+
+########################
+# Maven Javadoc Verify #
+########################
+
+- lf_maven_javadoc_verify: &lf_maven_javadoc_verify
+ name: lf-maven-javadoc-verify
+
+ # Produces javadocs for a Maven project.
+ #
+ # Expects javadocs to be available in $WORKSPACE/target/site/apidocs
+ #
+ # Required parameters:
+ # build-node: The node to run build on.
+ # jenkins-ssh-credential: Credential to use for SSH. (Generally should
+ # be configured in defaults.yaml)
+ # mvn-settings: The name of settings file containing credentials for
+ # the project.
+ #
+ # Optional parameters:
+ #
+ # :branch: The branch to build against. (default: master)
+ # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+ # :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ # :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
+ # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ # :java-version: Version of Java to use for the build. (default: openjdk8)
+ # :mvn-global-settings: The name of the Maven global settings to use for
+ # Maven configuration. (default: global-settings)
+ # :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ # :mvn-version: Version of maven to use. (default: mvn33)
+ # :stream: Keyword that can be used to represent a release code-name.
+ # Often the same as the branch. (default: master)
+ # :submodule-recursive: Whether to checkout submodules recursively.
+ # (default: true)
+ #
+ # :gerrit_verify_triggers: Override Gerrit Triggers.
+
+ ######################
+ # Default parameters #
+ ######################
+
+ branch: master
+ build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
+ build-timeout: 30
+ git-url: '$GIT_URL/$PROJECT'
+ java-version: openjdk8
+ mvn-global-settings: global-settings
+ mvn-opts: ''
+ mvn-params: ''
+ mvn-version: mvn33
+ staging-profile-id: '' # Unused by the javadoc jobs
+ stream: master
+ submodule-recursive: true
+
+ gerrit_verify_triggers:
+ - patchset-created-event:
+ exclude-drafts: true
+ exclude-trivial-rebase: false
+ exclude-no-code-change: false
+ - draft-published-event
+ - comment-added-contains-event:
+ comment-contains-value: recheck$
+
+ #####################
+ # Job Configuration #
+ #####################
+
+ builders:
+ - lf-maven-install:
+ mvn-version: '{mvn-version}'
+ - lf-provide-maven-settings:
+ global-settings-file: '{mvn-global-settings}'
+ settings-file: '{mvn-settings}'
+ - shell: !include-raw-escape:
+ - ../shell/common-variables.sh
+ - ../shell/maven-javadoc-generate.sh
+ - lf-provide-maven-settings-cleanup
+
+- job-template:
+ name: '{project-name}-maven-javadoc-verify-{stream}'
+ id: gerrit-maven-javadoc-verify
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_javadoc_verify
+
+ scm:
+ - lf-infra-gerrit-scm:
+ jenkins-ssh-credential: '{jenkins-ssh-credential}'
+ git-url: '{git-url}'
+ refspec: '$GERRIT_REFSPEC'
+ branch: '$GERRIT_BRANCH'
+ submodule-recursive: '{submodule-recursive}'
+ choosing-strategy: gerrit
+
+ triggers:
+ - gerrit:
+ server-name: '{gerrit-server-name}'
+ trigger-on: '{obj:gerrit_verify_triggers}'
+ projects:
+ - project-compare-type: ANT
+ project-pattern: '{project}'
+ branches:
+ - branch-compare-type: ANT
+ branch-pattern: '**/{branch}'
+
+- job-template:
+ name: '{project-name}-maven-javadoc-verify-{stream}'
+ id: github-maven-javadoc-verify
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_javadoc_verify
+
+ properties:
+ - github:
+ url: '{git-url}/{github-org}/{project}'
+
+ scm:
+ - lf-infra-github-scm:
+ url: '{git-clone-url}{github-org}/{project}'
+ refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
+ branch: '{branch}'
+ submodule-recursive: '{submodule-recursive}'
+ choosing-strategy: default
+ jenkins-ssh-credential: '{jenkins-ssh-credential}'
+
+ triggers:
+ - lf-infra-github-pr-trigger:
+ trigger-phrase: '^recheck$'
+ only-trigger-phrase: true
+ status-context: 'Maven Javadoc'
+ permit-all: true
+ github-hooks: true
+ github-org: ''
+ github_pr_whitelist:
+ - ''
+ github_pr_admin_list:
+ - ''
+
#################
# Maven Release #
#################
# directory can then be reused later to deploy to Nexus.
#
# Required parameters:
- # build-node: The node to run build on.
- # jenkins-ssh-credential: Credential to use for SSH. (Generally should
- # be configured in defaults.yaml)
- # mvn-settings: The name of settings file containing credentials for
- # the project.
- # staging-profile-id: Profile ID of the project's Nexus staging profile.
+ #
+ # :build-node: The node to run build on.
+ # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+ # be configured in defaults.yaml)
+ # :mvn-settings: The name of settings file containing credentials for
+ # the project.
+ # :mvn-staging-id: Maven Server ID from settings.xml to pull credentials from.
+ # (Note: This setting should be configured in defaults.yaml.)
+ # :staging-profile-id: Profile ID of the project's Nexus staging profile.
#
# Optional parameters:
- # :gerrit_verify_triggers: Override Gerrit Triggers.
+ #
+ # :branch: The branch to build against. (default: master)
+ # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+ # :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ # :cron: Cron schedule when to trigger the job. This parameter also
+ # supports multiline input via YAML pipe | character in cases where
+ # one may want to provide more than 1 cron timer. (default: '')
+ # :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
+ # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ # :java-version: Version of Java to use for the build. (default: openjdk8)
# :mvn-global-settings: The name of the Maven global settings to use for
- # Maven configuration. (default: global-settings)
+ # Maven configuration. (default: global-settings)
+ # :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ # :mvn-version: Version of maven to use. (default: mvn33)
+ # :stream: Keyword that can be used to represent a release code-name.
+ # Often the same as the branch. (default: master)
+ # :submodule-recursive: Whether to checkout submodules recursively.
+ # (default: true)
+ #
+ # :gerrit_release_triggers: Override Gerrit Triggers.
######################
# Default parameters #
branch: master
build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
build-timeout: 30
+ cron: ''
git-url: '$GIT_URL/$PROJECT'
java-version: openjdk8
mvn-global-settings: global-settings
global-settings-file: '{mvn-global-settings}'
settings-file: '{mvn-settings}'
- lf-infra-create-netrc:
- server-id: opendaylight-staging
+ server-id: '{mvn-staging-id}'
- shell: !include-raw-escape:
- ../shell/lftools-install.sh
- ../shell/common-variables.sh
choosing-strategy: default
triggers:
+ - timed: '{obj:cron}'
- gerrit:
server-name: '{gerrit-server-name}'
trigger-on: '{obj:gerrit_release_triggers}'
jenkins-ssh-credential: '{jenkins-ssh-credential}'
triggers:
+ - timed: '{obj:cron}'
- lf-infra-github-pr-trigger:
trigger-phrase: '^build release$'
only-trigger-phrase: true
# :mvn-opts: Sets MAVEN_OPTS. (default: '')
# :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
# :mvn-version: Version of maven to use. (default: mvn33)
+ # :stream: Keyword that can be used to represent a release code-name.
+ # Often the same as the branch. (default: master)
# :submodule-recursive: Whether to checkout submodules recursively.
# (default: true)
#
mvn-opts: ''
mvn-params: ''
mvn-version: mvn33
+ staging-profile-id: '' # Unused in this job
stream: master
submodule-recursive: true
- comment-added-contains-event:
comment-contains-value: run-sonar$
- # Staging repos do not make sense for CLM jobs so set it blank.
- staging-profile-id: ''
-
#####################
# Job Configuration #
#####################
mvn-opts: ''
mvn-params: '-Dstream=$STREAM'
mvn-version: mvn33
+ staging-profile-id: '' # Unused in this job
stream: master
submodule-recursive: true
gerrit_verify_triggers:
- patchset-created-event:
- exclude-drafts: false
+ exclude-drafts: true
exclude-trivial-rebase: false
exclude-no-code-change: false
- draft-published-event
- ''
github_pr_admin_list:
- ''
+
+#############################
+# Maven Verify Dependencies #
+#############################
+
+- lf_maven_verify_dependencies: &lf_maven_verify_dependencies
+ name: lf-maven-verify-dependencies
+
+ # Verify job which runs mvn clean install to test a project build /w deps
+ #
+ # This job can be used to verify a patch in conjunction to all of the
+ # upstream patches it depends on. The user of this job can provide a list
+ # via comment trigger. The trigger is:
+ #
+ # 'recheck: SPACE_SEPERATED_LIST_OF_PATCHES'
+ #
+ # Required parameters:
+ #
+ # :build-node: The node to run build on.
+ # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+ # be configured in defaults.yaml)
+ # :mvn-settings: The name of settings file containing credentials for
+ # the project.
+ #
+ # Optional parameters:
+ #
+ # :branch: Git branch to fetch for the build. (default: master)
+ # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+ # :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ # :java-version: Version of Java to use for the build. (default: openjdk8)
+ # :mvn-global-settings: The name of the Maven global settings to use for
+ # Maven configuration. (default: global-settings)
+ # :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ # :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ # :mvn-version: Version of maven to use. (default: mvn33)
+ # :stream: Keyword that can be used to represent a release code-name.
+ # Often the same as the branch. (default: master)
+ # :submodule-recursive: Whether to checkout submodules recursively.
+ # (default: true)
+ #
+ # :gerrit_verify_triggers: Override Gerrit Triggers.
+ # :gerrit_trigger_file_paths: Override file paths which can be used to
+ # filter which file modifications will trigger a build.
+
+ ######################
+ # Default parameters #
+ ######################
+
+ branch: master
+ build-days-to-keep: 7
+ build-timeout: 60
+ git-url: '$GIT_URL/$PROJECT'
+ java-version: openjdk8
+ mvn-global-settings: global-settings
+ mvn-opts: ''
+ mvn-params: '-Dstream=$STREAM'
+ mvn-version: mvn33
+ staging-profile-id: '' # Unused by this job
+ stream: master
+ submodule-recursive: true
+
+ gerrit_verify_triggers:
+ - comment-added-contains-event:
+ comment-contains-value: 'recheck: [0-9 ]+'
+ gerrit_trigger_file_paths:
+ - compare-type: ANT
+ pattern: '**'
+
+ #####################
+ # Job Configuration #
+ #####################
+
+ concurrent: true
+
+ builders:
+ - lf-jacoco-nojava-workaround
+ - lf-maven-install:
+ mvn-version: '{mvn-version}'
+ - lf-provide-maven-settings:
+ global-settings-file: '{mvn-global-settings}'
+ settings-file: '{mvn-settings}'
+ - lf-fetch-dependent-patches
+ - shell: !include-raw-escape:
+ - ../shell/common-variables.sh
+ - ../shell/maven-build-deps.sh
+ - shell: !include-raw-escape:
+ - ../shell/common-variables.sh
+ - ../shell/maven-build.sh
+ - lf-provide-maven-settings-cleanup
+
+ publishers:
+ - findbugs
+ - lf-jacoco-report
+ - lf-infra-publish
+
+- job-template:
+ name: '{project-name}-maven-verify-deps-{stream}-{mvn-version}-{java-version}'
+ id: gerrit-maven-verify-dependencies
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_verify_dependencies
+
+ scm:
+ - lf-infra-gerrit-scm:
+ jenkins-ssh-credential: '{jenkins-ssh-credential}'
+ git-url: '{git-url}'
+ refspec: '$GERRIT_REFSPEC'
+ branch: '$GERRIT_BRANCH'
+ submodule-recursive: '{submodule-recursive}'
+ choosing-strategy: gerrit
+
+ triggers:
+ - gerrit:
+ server-name: '{gerrit-server-name}'
+ trigger-on: '{obj:gerrit_verify_triggers}'
+ projects:
+ - project-compare-type: ANT
+ project-pattern: '{project}'
+ branches:
+ - branch-compare-type: ANT
+ branch-pattern: '**/{branch}'
+ file-paths: '{obj:gerrit_trigger_file_paths}'