Skip to Content

Changes for page Jenkins Shared Library

Last modified by Boris Folgmann on 2025/11/03 09:41
From version 9.2
edited by Boris Folgmann
on 2025/11/03 09:19
Change comment: There is no comment for this version
To version 3.1
edited by Boris Folgmann
on 2025/07/09 16:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  == Getting Started ==
8 8  
9 -Since the Shared Library is globally configured on all Jenkins instances managed by DevOps-as-a-Service you just need to place the following very short Jenkinsfile in the root folder of your git repository to automatically build your maven, node or go project or simply build a container using a Dockerfile.
9 +Since the Shared Library is globally configured on all Jenkins instances managed by DevOps-as-a-Service you just need to place the following very short Jenkinsfile in the root folder of your git repository to automatically build your maven or node project or simply build a container using a Dockerfile.
10 10  
11 11  {{code}}
12 12  @Library('sdcloud') _
... ... @@ -21,14 +21,13 @@
21 21  
22 22  What the pipeline currently does is visualised in the following image which shows an example for a maven-based Java project.
23 23  
24 -[[image:1762161531690-966.png||data-xwiki-image-style-border="true" height="247" width="1654"]]
24 +[[image:attach:image2022-5-17_17-51-43.png||height="250"]]
25 25  
26 26  1. Checking out the source code from git.
27 27  1. If a pom.xml is found your favorite JDK is selected, by default jdk11. Then a maven build is done.
28 28  1. If there's no pom.xml but a package.json is found a nodejs build is done.
29 -1. If there is no pom.xml or package.json but a go.mod file, a go build is done.
30 30  1. Then the following stages are executed in parallel
31 -11. Analysis: For maven projects the Java source code is checked by checkstyle, pmd and spotbugs. Furthermore the job output will be checked for any warnings generated by maven, javac or javadoc. If Python modules (.py files) exist in the git repository they will be analyzed using pylint and flake8. If pylint or flake8 are not available on the Jenkins agent the steps will be skipped. Python files that are generated or downloaded into the workspace will not be checked. The results will be displayed on the classical Jenkins build page after the build. For Go projects, the Go test tool is used to run all tests and produce a coverage output file for SonarQube. Additionally, the gotestsum tool is used to produce a report which is picked up by Jenkins.</dd>
30 +11. Analysis: For maven projects the Java source code is checked by checkstyle, pmd and spotbugs. Furthermore the job output will be checked for any warnings generated by maven, javac or javadoc. If Python modules (.py files) exist in the git repository they will be analyzed using pylint and flake8. If pylint or flake8 are not available on the Jenkins agent the steps will be skipped. Python files that are generated or downloaded into the workspace will not be checked. The results will be displayed on the classical Jenkins build page after the build.
32 32  11. Security: If it's not a feature or bugfix branch a dependency check is done which checks if e.g. libraries are used which have known vulnerabilities. The results will be displayed in Jenkins after the build.
33 33  11. Docker: this will also work for projects which are neither maven or nodejs. A Dockerfile is enough to trigger this part of the pipeline.
34 34  111. If a Dockerfile is found a docker image is built.
... ... @@ -126,14 +126,8 @@
126 126  )))|(((
127 127  'npm install && npm run build ~-~-prod'
128 128  )))|(((
129 -npm command to execute for building Node.JS projects.
128 +npm command to execute for building Node.JS projects.
130 130  )))
131 -|= |go|'go'|Golang version to use.
132 -Refers to a symbolic name of a go tool configuration in Jenkins.
133 -|= |goBuildCommand|(((
134 -'go build -o app cmd/server/main.go'
135 -)))|go build run. Should be overridden for your project.
136 -|= |goTestCommand|'gotestsum ~-~-format pkgname ~-~-junitfile report.xml ~-~- -failfast -race -coverprofile=coverage.out -tags=test ./...'|Runs gotestsum tool which in turn calls 'go test' for all packages in the project. Should be overridden for your project. The gotestsum tool is available out-of-the-box and produces a report file which is picked up by Jenkins automatically.
137 137  |=(% rowspan="10" %)(((
138 138  Docker build
139 139  )))|(((
... ... @@ -312,11 +312,9 @@
312 312  |(((
313 313  helmRegistry
314 314  )))|(((
315 -Helm registry of your DOaaS instance, which is usally 'https:~/~/registry-CUSTOMER.devops.t-systems.net/chartrepo/PROJECTKEY'
308 +Nexus registry of your DOaaS instance
316 316  )))|(((
317 -Helm registry to which the packaged Helm chart is uploaded.
318 -
319 -
310 +Name of registry to which the packaged Helm chart is uploaded.
320 320  )))
321 321  |(((
322 322  helmRegistryCredentialsId
... ... @@ -355,7 +355,7 @@
355 355  )))|(((
356 356  Id of the Jenkins Credentials for signers private keyfile.
357 357  )))
358 -|=(% colspan="1" rowspan="8" %)(((
349 +|=(% colspan="1" rowspan="12" %)(((
359 359  Static Source Code Analysis
360 360  )))|(((
361 361  checkstyleConfig
... ... @@ -380,7 +380,29 @@
380 380  )))|(((
381 381   Name of a config file to use for yamllint. If not set a best-practice[[ relaxed configuration >>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse/resources/com/tsystems/sdc/jenkinslib/yamllint.yml||shape="rect"]]is used which is different from the original yamllint[[ config>>url:https://yamllint.readthedocs.io/en/stable/configuration.html#default-configuration||shape="rect"]].
382 382  )))
374 +|skipDependencyCheck|false|Set to true to skip the dependency-check.
383 383  |(((
376 +dependencyCheckTool
377 +)))|(((
378 +'dependency-check'
379 +)))|(((
380 +Defines which named dependency-check tool should be used.
381 +)))
382 +|(((
383 +dependencyCheckArgs
384 +)))|(((
385 +'~-~-disableAssembly ~-~-nvdValidForHours 720'
386 +)))|(((
387 +Addtional arguments which are be passed to dependency-check. See [[Dependency>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]][[ Check CLI Arguments>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]] for more information.
388 +)))
389 +|(((
390 +dependencyCheckNvdApiKeyCredentialsId
391 +)))|(((
392 +'dependency-check-nvdapikey'
393 +)))|(((
394 +If you have your own NVD API Key, set it as a credential of type text in Jenkins. Then specify the credential id using this argument. It will be automatically passed to dependency-check. There will be no error if no credential is found. Just the NVD download will be slower. Please note, on DevOps-as-a-Service a shared NVD API Key is automatically supplied for the default credential id.
395 +)))
396 +|(((
384 384  sonarQube
385 385  )))|(((
386 386  true for the defaultBranch and for pull-requests, if a SonarQube version is detected which supports scanning multiple branches
... ... @@ -431,23 +431,6 @@
431 431  |sonarQualityGate| |Sets the desired quality gate to use for the scan result in SonarQube.
432 432  If not specified, the quality gate is not changed.
433 433  As a default, SonarQube will use the quality gate "Sonar way" for new scan results.
434 -|=(% colspan="1" rowspan="5" %)Dependency Check|skipDependencyCheck|false|Set to true to skip the dependency-check.
435 -|dependencyCheckTool|'dependency-check'|Defines which named dependency-check tool should be used.
436 -|dependencyCheckMvnArgs|'-DassemblyAnalyzerEnabled=false'|Additional arguments which are be passed to dependency-check for maven projects.(((
437 -See [[Dependency Check Maven Configuration>>https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html]] for more information.
438 -)))
439 -|dependencyCheckArgs|'~-~-disableAssembly'|Addtional arguments which are be passed to dependency-check. See [[Dependency>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]][[ Check CLI Arguments>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]] for more information.
440 -|dependencyCheckNvdApiKeyCredentialsId|'dependency-check-nvdapikey'|If you have your own NVD API Key, set it as a credential of type text in Jenkins. Then specify the credential id using this argument. It will be automatically passed to dependency-check. There will be no error if no credential is found. Just the NVD download will be slower. Please note, on DevOps-as-a-Service a shared NVD API Key is automatically supplied for the default credential id.
441 -|=(% colspan="1" rowspan="2" %)Dependency Track|depTrackCredentialsId|'PROJECTKEY-deptrack-projectcreator'|(((
442 -Id of the Jenkins Credential which has to be used to authenticate to Dependency Track for publishing the SBOM.
443 -)))
444 -|depTrackClassifier|'application'|The component type (e.g. application, library, firmware, ...) that should be set in the SBOM file.
445 -Will be later shown as classifier for the project in Dependency Track.
446 -See [[CycloneDX Metadata Component Type>>https://cyclonedx.org/docs/1.6/json/#metadata_component_type]] for supported values.
447 -|=(% colspan="1" rowspan="2" %)Trivy|trivySeverity|'High'|String which sets the minimum severity of Trivy findings that has to be reached to mark the Trivy Results stage as unstable.
448 -Possible values are: "None", "Unknown", "Negligible", "Low", "Medium", "High", "Critical".
449 -|trivyBuildResult|'SUCCESS'|String which sets the overall build result when the result of the Trivy scan reaches trivyServerity.
450 -Possible values are: "SUCCESS", "UNSTABLE" or "FAILURE"
451 451  |=(% rowspan="7" %)(((
452 452  Deployment
453 453  )))|(((
1762161476370-318.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.borisfolgmannt-systemscom
Size
... ... @@ -1,1 +1,0 @@
1 -79.4 KB
Content
1762161531690-966.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.borisfolgmannt-systemscom
Size
... ... @@ -1,1 +1,0 @@
1 -82.3 KB
Content
© 2018-2025 T-Systems International GmbH