Skip to Content

Changes for page Jenkins Shared Library

Last modified by Boris Folgmann on 2025/11/03 09:41
From version 6.10
edited by Boris Folgmann
on 2025/11/03 09:14
Change comment: There is no comment for this version
To version 11.1
edited by Boris Folgmann
on 2025/11/03 09:41
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 or node 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, node or go project or simply build a container using a Dockerfile.
10 10  
11 11  {{code}}
12 12  @Library('sdcloud') _
... ... @@ -21,29 +21,35 @@
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:attach:image2022-5-17_17-51-43.png||height="250"]]
24 +[[image:1762161531690-966.png||data-xwiki-image-style-border="true" height="247" width="1654"]]
25 25  
26 -1. Checking out the source code from git.
27 -1. If a pom.xml is found your favorite JDK is selected, by default jdk11. Then a maven build is done.
28 -1. If there's no pom.xml but a package.json is found a nodejs build is done.
26 +1. **sdcPipeline **prints some valuable information about this shared Jenkinslib. Allocates a node (Jenkins Agent) to start executing the pipeline.
27 +1. **Checkout**: checking out the source code from git.
28 +1. **JDK**: If a pom.xml is found, your favorite JDK or the current default is selected .
29 +1. **Maven Build**: If a pom.xml is found, a maven build is done.
30 +1. If there's no pom.xml, but a package.json is found a nodejs build is done.
29 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>
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 -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 -111. If a Dockerfile is found a docker image is built.
35 -111. The image is started as an isolated container on the Jenkins agent.
36 -111. Any loglines written to stdout or stderr by the container will be displayed.
37 -111. A smoke test is performed which is a simple query for a valid answer on the exposed port of the container.
38 -111. If the smoke test was successful and the build was not done for a pull request the docker image will be pushed to the docker registry.
39 -111. For easy identification of the image 3 image tags are defined:
33 +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.
34 +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.
35 +If SonarQube is configured fore this Jenkins instance, a **Sonar Scan** is performed on the agent and the result is pushed to SonarQube for further processing.
36 +11. **Security**:
37 +111. 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.
38 +111. If Dependency Track is enabled for the current project, an SBOM file is created and archived in the build. In addition it's pushed to Dependency Track. Jenkins will wait for DepTrack to process the SBOM and display information about found potential vulnerabilities in the build.
39 +11. **Docker**: this will also work for projects which are neither maven, nodejs or go. A Dockerfile is enough to trigger this part of the pipeline.
40 +111. **Build Container Image**: If a Dockerfile is found a docker image is built.
41 +111. **Test Container Image**: The image is started as an isolated container on the Jenkins agent. Any loglines written to stdout or stderr by the container will be displayed.A smoke test is performed which is a simple query for a valid answer on the exposed port of the container.
42 +111. **Push Container Image**: If the smoke test was successful the container image will be pushed to the image registry.
43 +For easy identification of the image 3 image tags are defined:
40 40  1111. BRANCH_NAME-BUILD_NUMBER (e.g. 'production-1014')
41 41  1111. BRANCH_NAME-GIT_HASH (e.g. 'develop-8a7c4f2')
42 42  1111. BRANCH_NAME-latest (e.g. 'feature-PKEY-42-latest')
43 43  1111. (If BRANCH_NAME is defaultBranch the prefix 'BRANCH_NAME-' will not be included.)
44 -111. When a chart/Chart.yaml is found and  it's not a pull request a Helm Chart will be created and pushed to the Helm Chart repository.
45 -1. Yamllint will check all YAML files in the workspace for errors and warnings. This is done at this place since the Create Helm Chart stage modifies or creates YAML files which should be also checked before the pipeline proceeds.
46 -1. When depolyHelmChart is set to true the Helm chart will be deployed to the Kubernestes cluster and namespace of your choice. Not done in the example diagram.
48 +111. **Create Helm Chart**: When a chart/Chart.yaml is found and it's not a pull-request, a Helm Chart will be created and pushed to the Helm Chart repository.
49 +1. **Yamllint **will check all YAML files in the workspace for errors and warnings. This is done at this place since the Create Helm Chart stage modifies or creates YAML files which should be also checked before the pipeline proceeds.
50 +1. **Deploy application**: when depolyHelmChart is set to true the Helm chart will be deployed to the Kubernestes cluster and namespace of your choice. Not done in the example diagram.
51 +1. **Trivy Results**: if a container image was pushed to Harbor as the container registry, the results of the Trivy security scan are fetched from Harbor
52 +1. **Sonar Results**: finally the pipeline waits for the result of the Sonar Quality Gate to decide on the success of the build.
47 47  
48 48  == {{id name="pipeline_customization"/}}Pipeline Customization ==
49 49  
... ... @@ -135,7 +135,7 @@
135 135  )))|go build run. Should be overridden for your project.
136 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 -Docker build
144 +Container build
139 139  )))|(((
140 140  dockerBuildPath
141 141  )))|(((
... ... @@ -209,7 +209,7 @@
209 209  Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
210 210  )))
211 211  |=(% rowspan="7" %)(((
212 -Docker container test
218 +Container test
213 213  )))|(((
214 214  skipSmokeTest
215 215  )))|(((
... ... @@ -260,7 +260,7 @@
260 260  Total time in seconds after which the container is expected to be up and running even if it's still writing loglines to stdout. After this time has passed the container will be queried for an answer.
261 261  )))
262 262  |=(% rowspan="2" %)(((
263 -Docker push
269 +Image push
264 264  )))|(((
265 265  pushDockerRegistry
266 266  )))|(((
... ... @@ -276,7 +276,7 @@
276 276  Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
277 277  )))
278 278  |=(% rowspan="6" %)(((
279 -Helm chart
285 +Helm Chart
280 280  )))|(((
281 281  helmChartPath
282 282  )))|(((
... ... @@ -355,7 +355,7 @@
355 355  )))|(((
356 356  Id of the Jenkins Credentials for signers private keyfile.
357 357  )))
358 -|=(% colspan="1" rowspan="13" %)(((
364 +|=(% colspan="1" rowspan="8" %)(((
359 359  Static Source Code Analysis
360 360  )))|(((
361 361  checkstyleConfig
... ... @@ -380,32 +380,7 @@
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  )))
383 -|skipDependencyCheck|false|Set to true to skip the dependency-check.
384 384  |(((
385 -dependencyCheckTool
386 -)))|(((
387 -'dependency-check'
388 -)))|(((
389 -Defines which named dependency-check tool should be used.
390 -)))
391 -|dependencyCheckMvnArgs|'-DassemblyAnalyzerEnabled=false'|Additional arguments which are be passed to dependency-check for maven projects.(((
392 -See [[Dependency Check Maven Configuration>>https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html]] for more information.
393 -)))
394 -|(((
395 -dependencyCheckArgs
396 -)))|(((
397 -'~-~-disableAssembly'
398 -)))|(((
399 -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.
400 -)))
401 -|(((
402 -dependencyCheckNvdApiKeyCredentialsId
403 -)))|(((
404 -'dependency-check-nvdapikey'
405 -)))|(((
406 -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.
407 -)))
408 -|(((
409 409  sonarQube
410 410  )))|(((
411 411  true for the defaultBranch and for pull-requests, if a SonarQube version is detected which supports scanning multiple branches
... ... @@ -456,13 +456,13 @@
456 456  |sonarQualityGate| |Sets the desired quality gate to use for the scan result in SonarQube.
457 457  If not specified, the quality gate is not changed.
458 458  As a default, SonarQube will use the quality gate "Sonar way" for new scan results.
459 -|=(% colspan="1" %)Dependency Check|skipDependencyCheck|false|Set to true to skip the dependency-check.
460 -|=(% colspan="1" %) |dependencyCheckTool|'dependency-check'|Defines which named dependency-check tool should be used.
461 -|=(% colspan="1" %) |dependencyCheckMvnArgs|'-DassemblyAnalyzerEnabled=false'|Additional arguments which are be passed to dependency-check for maven projects.(((
440 +|=(% colspan="1" rowspan="5" %)Dependency Check|skipDependencyCheck|false|Set to true to skip the dependency-check.
441 +|dependencyCheckTool|'dependency-check'|Defines which named dependency-check tool should be used.
442 +|dependencyCheckMvnArgs|'-DassemblyAnalyzerEnabled=false'|Additional arguments which are be passed to dependency-check for maven projects.(((
462 462  See [[Dependency Check Maven Configuration>>https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html]] for more information.
463 463  )))
464 -|=(% colspan="1" %) |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.
465 -|=(% colspan="1" %) |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.
445 +|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.
446 +|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.
466 466  |=(% colspan="1" rowspan="2" %)Dependency Track|depTrackCredentialsId|'PROJECTKEY-deptrack-projectcreator'|(((
467 467  Id of the Jenkins Credential which has to be used to authenticate to Dependency Track for publishing the SBOM.
468 468  )))
1762161476370-318.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.borisfolgmannt-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +79.4 KB
Content
1762161531690-966.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.borisfolgmannt-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +82.3 KB
Content
© 2018-2025 T-Systems International GmbH