# COMMON FUNCTIONS #
####################
-- lf_maven_common: &lf_maven_common
+- _lf_maven_common: &lf_maven_common
name: lf-maven-common
######################
# Maven CLM #
#############
-- lf_maven_clm: &lf_maven_clm
+- _lf_maven_clm: &lf_maven_clm
name: lf-maven-clm
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ java-version: openjdk13
mvn-global-settings: global-settings
mvn-goals: clean install
mvn-opts: ""
github-hooks: true
org-list:
- "{github-org}"
- white-list: "{obj:github_pr_whitelist}"
+ white-list: "{obj:github_pr_allowlist}"
+ admin-list: "{obj:github_pr_admin_list}"
+ white-list-target-branches:
+ - "{branch}"
+
+##################
+# Maven Snyk CLI #
+##################
+
+- _lf_maven_snyk_cli: &lf_maven_snyk_cli
+ name: lf-maven-snyk_cli
+
+ ######################
+ # Default parameters #
+ ######################
+
+ branch: master
+ build-days-to-keep: 30 # 30 days for troubleshooting purposes
+ build-timeout: 60
+ disable-job: false
+ git-url: "$GIT_URL/$PROJECT"
+ github-url: "https://github.com"
+ java-version: openjdk11
+ mvn-global-settings: global-settings
+ mvn-goals: clean install
+ mvn-opts: ""
+ mvn-params: ""
+ mvn-version: mvn35
+ snyk-cli-options: ""
+ snyk-token-credential-id: snyk-token
+ snyk-org-credential-id: snyk-org
+ stream: master
+ submodule-recursive: true
+ submodule-timeout: 10
+ submodule-disable: false
+
+ gerrit_snyk_triggers:
+ - comment-added-contains-event:
+ comment-contains-value: '^Patch Set\s+\d+:\s+run-snyk\s*$'
+
+ parameters:
+ - lf-infra-parameters:
+ project: "{project}"
+ branch: "{branch}"
+ stream: "{stream}"
+ - lf-infra-maven-parameters:
+ mvn-opts: "{mvn-opts}"
+ mvn-params: "{mvn-params}"
+ mvn-version: "{mvn-version}"
+ - string:
+ name: SNYK_CLI_OPTIONS
+ default: "{snyk-cli-options}"
+ description: Additional Snyk CLI commands and options
+ - string:
+ name: ARCHIVE_ARTIFACTS
+ default: "{archive-artifacts}"
+ description: Artifacts to archive to the logs server.
+
+ wrappers:
+ - credentials-binding:
+ - text:
+ credential-id: "{snyk-token-credential-id}"
+ variable: SNYK_TOKEN
+ - text:
+ credential-id: "{snyk-org-credential-id}"
+ variable: SNYK_ORG
+
+ #####################
+ # Job Configuration #
+ #####################
+
+ disabled: "{disable-job}"
+
+ builders:
+ - lf-infra-pre-build
+ - lf-maven-install:
+ mvn-version: "{mvn-version}"
+ - lf-update-java-alternatives:
+ java-version: "{java-version}"
+ - lf-provide-maven-settings:
+ global-settings-file: "{mvn-global-settings}"
+ settings-file: "{mvn-settings}"
+ - lf-maven-build:
+ mvn-goals: "{mvn-goals}"
+ - lf-infra-snyk-cli-scanner
+ - lf-provide-maven-settings-cleanup
+ - shell: 'find . -regex ".*karaf/target" | xargs rm -rf'
+
+- builder:
+ name: lf-infra-snyk-cli-scanner
+ # Download and run the Snyk CLI scanner
+ builders:
+ - shell: !include-raw-escape:
+ - ../shell/snyk-cli-scanner-run.sh
+
+- job-template:
+ name: "{project-name}-maven-snyk-cli-{stream}"
+ id: gerrit-maven-snyk-cli
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_snyk_cli
+
+ 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}"
+ submodule-timeout: "{submodule-timeout}"
+ submodule-disable: "{submodule-disable}"
+ choosing-strategy: default
+
+ triggers:
+ # Build weekly on Saturdays
+ - timed: "H H * * 6"
+ - gerrit:
+ server-name: "{gerrit-server-name}"
+ trigger-on: "{obj:gerrit_snyk_triggers}"
+ projects:
+ - project-compare-type: ANT
+ project-pattern: "{project}"
+ branches:
+ - branch-compare-type: ANT
+ branch-pattern: "**/{branch}"
+ skip-vote:
+ successful: true
+ failed: true
+ unstable: true
+ notbuilt: true
+
+- job-template:
+ name: "{project-name}-maven-snyk-cli-{stream}"
+ id: github-maven-snyk-cli
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_snyk_cli
+
+ properties:
+ - lf-infra-properties:
+ build-days-to-keep: "{build-days-to-keep}"
+ - github:
+ url: "{github-url}/{github-org}/{project}"
+
+ scm:
+ - lf-infra-github-scm:
+ url: "{git-clone-url}{github-org}/{project}"
+ refspec: ""
+ branch: "refs/heads/{branch}"
+ submodule-recursive: "{submodule-recursive}"
+ submodule-timeout: "{submodule-timeout}"
+ submodule-disable: "{submodule-disable}"
+ choosing-strategy: default
+ jenkins-ssh-credential: "{jenkins-ssh-credential}"
+
+ triggers:
+ # Build weekly on Saturdays
+ - timed: "H H * * 6"
+ - github-pull-request:
+ trigger-phrase: "^run-snyk$"
+ only-trigger-phrase: true
+ status-context: "SNYK scan"
+ permit-all: true
+ github-hooks: true
+ org-list:
+ - "{github-org}"
+ white-list: "{obj:github_pr_allowlist}"
admin-list: "{obj:github_pr_admin_list}"
white-list-target-branches:
- "{branch}"
# Maven Javadoc Publish #
#########################
-- lf_maven_javadoc_publish: &lf_maven_javadoc_publish
+- _lf_maven_javadoc_publish: &lf_maven_javadoc_publish
name: lf-maven-javadoc-publish
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ java-version: openjdk11
mvn-dir: "."
mvn-global-settings: global-settings
mvn-opts: ""
github-hooks: true
org-list:
- "{github-org}"
- white-list: "{obj:github_pr_whitelist}"
+ white-list: "{obj:github_pr_allowlist}"
admin-list: "{obj:github_pr_admin_list}"
white-list-target-branches:
- "{branch}"
# Maven Javadoc Verify #
########################
-- lf_maven_javadoc_verify: &lf_maven_javadoc_verify
+- _lf_maven_javadoc_verify: &lf_maven_javadoc_verify
name: lf-maven-javadoc-verify
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ java-version: openjdk11
mvn-dir: "."
mvn-global-settings: global-settings
mvn-opts: ""
# Maven Merge #
###############
-- lf_maven_merge: &lf_maven_merge
+- _lf_maven_merge: &lf_maven_merge
name: lf-maven-merge
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ jacoco-exclude-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
+ java-version: openjdk11
mvn-global-settings: global-settings
mvn-goals: clean deploy
mvn-opts: ""
mvn-params: "-Dmerge"
mvn-version: mvn35
nexus-cut-dirs: 6 # Number of dirs in the Nexus path to remove for wget -r.
+ pre-build-script: "# pre-build script goes here"
+ post-build-script: "# post-build script goes here"
stream: master
submodule-recursive: true
submodule-timeout: 10
NEXUS_CUT_DIRS={nexus-cut-dirs}
NEXUS_REPO={nexus-snapshot-repo}
- shell: !include-raw-escape: ../shell/maven-fetch-metadata.sh
+ - shell: "{pre-build-script}"
- lf-maven-build:
mvn-goals: "{mvn-goals}"
+ - shell: "{post-build-script}"
- lf-maven-deploy
- lf-provide-maven-settings-cleanup
publishers:
- findbugs
- - lf-jacoco-report
+ - lf-jacoco-report:
+ exclude-pattern: "{jacoco-exclude-pattern}"
- lf-infra-publish
- trigger-parameterized-builds: "{obj:post_build_trigger}"
github-hooks: true
org-list:
- "{github-org}"
- white-list: "{obj:github_pr_whitelist}"
+ white-list: "{obj:github_pr_allowlist}"
admin-list: "{obj:github_pr_admin_list}"
white-list-target-branches:
- "{branch}"
# Maven Merge for Docker #
##########################
-- lf_maven_docker_merge: &lf_maven_docker_merge
+- _lf_maven_docker_merge: &lf_maven_docker_merge
name: lf-maven-docker-merge
builders:
github-hooks: true
org-list:
- "{github-org}"
- white-list: "{obj:github_pr_whitelist}"
+ white-list: "{obj:github_pr_allowlist}"
admin-list: "{obj:github_pr_admin_list}"
white-list-target-branches:
- "{branch}"
# Maven Stage #
###############
-- lf_maven_stage: &lf_maven_stage
+- _lf_maven_stage: &lf_maven_stage
name: lf-maven-stage
######################
branch: master
build-days-to-keep: 30 # 30 days in case a release takes long to get approved.
build-timeout: 60
- cron: "@daily"
+ cron: ""
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ java-version: openjdk11
maven-versions-plugin: false
version-properties-file: version.properties
mvn-central: false
mvn-version: mvn35
ossrh-profile-id: ""
mvn-pom: ""
+ sbom-flags: ""
+ sbom-path: "$WORKSPACE"
+ sbom-generator: false
+ sbom-generator-version: "v0.0.15"
sign-artifacts: false
sign-mode: serial
stream: master
name: STAGING_PROFILE_ID
default: "{staging-profile-id}"
description: Nexus staging profile ID.
+ - string:
+ name: SBOM_GENERATOR_VERSION
+ default: "{sbom-generator-version}"
+ description: SBOM generator version to download and run.
+ - string:
+ name: SBOM_PATH
+ default: "{sbom-path}"
+ description: path where SBOM needs to be executed.
builders:
- lf-infra-pre-build
- shell: !include-raw-escape: ../shell/maven-patch-release.sh
- lf-maven-build:
mvn-goals: "{mvn-goals}"
+ # With SBOM Generator
+ - conditional-step:
+ condition-kind: boolean-expression
+ condition-expression: "{sbom-generator}"
+ steps:
+ - shell: echo 'Running SBOM Generator'
+ - lf-infra-maven-sbom-generator:
+ sbom-flags: "{sbom-flags}"
- lf-sigul-sign-dir:
sign-artifacts: "{sign-artifacts}"
sign-dir: "$WORKSPACE/m2repo"
# Maven Stage for Docker #
##########################
-- lf_maven_docker_stage: &lf_maven_docker_stage
+- _lf_maven_docker_stage: &lf_maven_docker_stage
name: lf-maven-docker-stage
builders:
# Maven Sonar #
###############
-- lf_maven_sonar: &lf_maven_sonar
+- _lf_maven_sonar: &lf_maven_sonar
name: lf-maven-sonar
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ jacoco-exclude-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
+ java-version: openjdk11
java-opts: ""
mvn-global-settings: global-settings
mvn-goals: clean install
sonarcloud: false
sonarcloud-project-key: ""
sonarcloud-project-organization: ""
- sonarcloud-api-token: ""
- # SonarCloud scan using jdk8 will become deprecated by Oct, 2020
- # Projects not compatible with jdk11 can set java-version to something else
- sonarcloud-java-version: openjdk11
+ sonarcloud-api-token-cred-id: sonarcloud-api-token
+ sonarcloud-qualitygate-wait: false
+ # Projects not compatible with jdk13 can set java-version to something else
+ sonarcloud-java-version: openjdk13
stream: master
submodule-recursive: true
submodule-timeout: 10
submodule-disable: false
+ scan-dev-branch: false
gerrit_sonar_triggers:
- comment-added-contains-event:
however to use a specific version of the sonar-maven-plugin we
can call "org.codehaus.mojo:sonar-maven-plugin:3.3.0.603:sonar".
+ wrappers:
+ - credentials-binding:
+ - text:
+ credential-id: "{sonarcloud-api-token-cred-id}"
+ variable: API_TOKEN
+
triggers:
- timed: "{obj:cron}"
- gerrit:
unstable: true
notbuilt: true
+ publishers:
+ - lf-jacoco-report:
+ exclude-pattern: "{jacoco-exclude-pattern}"
+ - findbugs
+ - lf-infra-publish
+
+- _mvn_sonar_builders: &mvn_sonar_builders
+ name: mvn-sonar-builders
builders:
- lf-infra-pre-build
# With SonarCloud
mvn-version: "{mvn-version}"
sonarcloud-project-key: "{sonarcloud-project-key}"
sonarcloud-project-organization: "{sonarcloud-project-organization}"
- sonarcloud-api-token: "{sonarcloud-api-token}"
sonarcloud-java-version: "{sonarcloud-java-version}"
+ sonarcloud-qualitygate-wait: "{sonarcloud-qualitygate-wait}"
+ scan-dev-branch: "{scan-dev-branch}"
# With SonarQube
- conditional-step:
condition-kind: not
mvn-settings: "{mvn-settings}"
mvn-version: "{mvn-version}"
- publishers:
- - lf-jacoco-report
- - findbugs
- - lf-infra-publish
+- _mvn_sonar_builders_prescan_script: &mvn_sonar_builders_prescan_script
+ name: mvn-sonar-builders-prescan-script
+ builders:
+ - shell: "{sonar-prescan-script}"
+ - lf-infra-pre-build
+ # With SonarCloud
+ - conditional-step:
+ condition-kind: boolean-expression
+ condition-expression: "{sonarcloud}"
+ steps:
+ - shell: echo 'Using SonarCloud'
+ - lf-infra-maven-sonarcloud:
+ java-version: "{java-version}"
+ mvn-goals: "{mvn-goals}"
+ mvn-settings: "{mvn-settings}"
+ mvn-version: "{mvn-version}"
+ sonarcloud-project-key: "{sonarcloud-project-key}"
+ sonarcloud-project-organization: "{sonarcloud-project-organization}"
+ sonarcloud-java-version: "{sonarcloud-java-version}"
+ sonarcloud-qualitygate-wait: "{sonarcloud-qualitygate-wait}"
+ scan-dev-branch: "{scan-dev-branch}"
+ # With SonarQube
+ - conditional-step:
+ condition-kind: not
+ condition-operand:
+ condition-kind: boolean-expression
+ condition-expression: "{sonarcloud}"
+ steps:
+ - shell: echo 'Using SonarQube'
+ - lf-infra-maven-sonar:
+ java-version: "{java-version}"
+ mvn-goals: "{mvn-goals}"
+ mvn-settings: "{mvn-settings}"
+ mvn-version: "{mvn-version}"
+
+- builder:
+ name: lf-infra-maven-sbom-generator
+ # Run Maven goals and trigger SPDX SBOM Generator tool
+ builders:
+ - inject:
+ properties-content: |
+ SBOM_FLAGS={sbom-flags}
+ - shell: !include-raw-escape:
+ - ../shell/sbom-generator.sh
- builder:
name: lf-infra-maven-sonar
PROJECT_KEY={sonarcloud-project-key}
PROJECT_ORGANIZATION={sonarcloud-project-organization}
MAVEN_GOALS={mvn-goals}
- API_TOKEN={sonarcloud-api-token}
SONARCLOUD_JAVA_VERSION={sonarcloud-java-version}
+ SCAN_DEV_BRANCH={scan-dev-branch}
+ SONARCLOUD_QUALITYGATE_WAIT={sonarcloud-qualitygate-wait}
- lf-provide-maven-settings:
global-settings-file: global-settings
settings-file: "{mvn-settings}"
<<: *lf_maven_common
# yamllint disable-line rule:key-duplicates
<<: *lf_maven_sonar
+ <<: *mvn_sonar_builders
+
+ 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}"
+ submodule-timeout: "{submodule-timeout}"
+ submodule-disable: "{submodule-disable}"
+ choosing-strategy: default
+
+- job-template:
+ name: "{project-name}-sonar-verify"
+ id: gerrit-maven-sonar-verify
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_sonar
+ <<: *mvn_sonar_builders
+
+ sonarcloud: true
+ scan-dev-branch: true
+ sonarcloud-qualitygate-wait: false
+
+ gerrit_sonar_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: '^Patch Set\s+\d+:\s+(recheck|reverify)\s*$'
+
+ gerrit_trigger_file_paths:
+ - compare-type: REG_EXP
+ pattern: ".*"
+
+ triggers:
+ - gerrit:
+ server-name: "{gerrit-server-name}"
+ trigger-on: "{obj:gerrit_sonar_triggers}"
+ projects:
+ - project-compare-type: "ANT"
+ project-pattern: "{project}"
+ branches:
+ - branch-compare-type: "ANT"
+ branch-pattern: "**/{branch}"
+ file-paths: "{obj:gerrit_trigger_file_paths}"
+
+ 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}"
+ submodule-timeout: "{submodule-timeout}"
+ submodule-disable: "{submodule-disable}"
+ choosing-strategy: gerrit
+
+- job-template:
+ name: "{project-name}-sonar-prescan-script"
+ id: gerrit-maven-sonar-prescan-script
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_sonar
+ <<: *mvn_sonar_builders_prescan_script
scm:
- lf-infra-gerrit-scm:
github-hooks: true
org-list:
- "{github-org}"
- white-list: "{obj:github_pr_whitelist}"
+ white-list: "{obj:github_pr_allowlist}"
+ admin-list: "{obj:github_pr_admin_list}"
+ white-list-target-branches:
+ - "{branch}"
+
+- job-template:
+ name: "{project-name}-sonar-prescan-script"
+ id: github-maven-sonar-prescan-script
+ <<: *lf_maven_common
+ # yamllint disable-line rule:key-duplicates
+ <<: *lf_maven_sonar
+ <<: *mvn_sonar_builders_prescan_script
+
+ properties:
+ - lf-infra-properties:
+ build-days-to-keep: "{build-days-to-keep}"
+ - github:
+ url: "{github-url}/{github-org}/{project}"
+
+ scm:
+ - lf-infra-github-scm:
+ url: "{git-clone-url}{github-org}/{project}"
+ refspec: "+refs/pull/*:refs/remotes/origin/pr/*"
+ branch: "$sha1"
+ submodule-recursive: "{submodule-recursive}"
+ submodule-timeout: "{submodule-timeout}"
+ submodule-disable: "{submodule-disable}"
+ choosing-strategy: default
+ jenkins-ssh-credential: "{jenkins-ssh-credential}"
+
+ triggers:
+ - timed: "{obj:cron}"
+ - github-pull-request:
+ trigger-phrase: "^run-sonar$"
+ only-trigger-phrase: true
+ status-context: "Maven Sonar"
+ permit-all: true
+ github-hooks: true
+ org-list:
+ - "{github-org}"
+ white-list: "{obj:github_pr_allowlist}"
admin-list: "{obj:github_pr_admin_list}"
white-list-target-branches:
- "{branch}"
# Maven Verify #
################
-- lf_maven_verify: &lf_maven_verify
+- _lf_maven_verify: &lf_maven_verify
name: lf-maven-verify
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ jacoco-exclude-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
+ java-version: openjdk11
mvn-global-settings: global-settings
mvn-goals: clean deploy
mvn-opts: ""
mvn-params: "-Dstream=$STREAM -Dmaven.source.skip=true"
mvn-version: mvn35
+ pre-build-script: "# pre-build script goes here"
+ post-build-script: "# post-build script goes here"
stream: master
submodule-recursive: true
submodule-timeout: 10
- lf-provide-maven-settings:
global-settings-file: "{mvn-global-settings}"
settings-file: "{mvn-settings}"
+ - shell: "{pre-build-script}"
- lf-maven-build:
mvn-goals: "{mvn-goals}"
+ - shell: "{post-build-script}"
- lf-provide-maven-settings-cleanup
publishers:
- findbugs
- - lf-jacoco-report
+ - lf-jacoco-report:
+ exclude-pattern: "{jacoco-exclude-pattern}"
- lf-infra-publish
- job-template:
# Maven Verify for Docker #
###########################
-- lf_maven_docker_verify: &lf_maven_docker_verify
+- _lf_maven_docker_verify: &lf_maven_docker_verify
name: lf-maven-docker-verify
# image push not allowed during verification
# Maven Verify Dependencies #
#############################
-- lf_maven_verify_dependencies: &lf_maven_verify_dependencies
+- _lf_maven_verify_dependencies: &lf_maven_verify_dependencies
name: lf-maven-verify-dependencies
######################
disable-job: false
git-url: "$GIT_URL/$PROJECT"
github-url: "https://github.com"
- java-version: openjdk8
+ jacoco-exclude-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
+ java-version: openjdk11
mvn-global-settings: global-settings
mvn-goals: clean deploy
mvn-opts: ""
publishers:
- findbugs
- - lf-jacoco-report
+ - lf-jacoco-report:
+ exclude-pattern: "{jacoco-exclude-pattern}"
- lf-infra-publish
- job-template:
Code Review / releng / global-jjb.git / blobdiff