Changes for page Jenkins Shared Library

Last modified by Boris Folgmann on 2025/11/03 09:41

From version 6.2
edited by Boris Folgmann
on 2025/11/03 09:01
Change comment: There is no comment for this version
To version 9.3
edited by Boris Folgmann
on 2025/11/03 09:20
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,8 +21,9 @@
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. sdcPipeline prints some valuable information about this shared Jenkinslib. Allocates a node (Jenkins Agent) to start executing
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.
... ... @@ -312,9 +312,11 @@
312 312  |(((
313 313  helmRegistry
314 314  )))|(((
315 -Nexus registry of your DOaaS instance
316 +Helm registry of your DOaaS instance, which is usally 'https:~/~/registry-CUSTOMER.devops.t-systems.net/chartrepo/PROJECTKEY'
316 316  )))|(((
317 -Name of registry to which the packaged Helm chart is uploaded.
318 +Helm registry to which the packaged Helm chart is uploaded.
319 +
320 +
318 318  )))
319 319  |(((
320 320  helmRegistryCredentialsId
... ... @@ -353,7 +353,7 @@
353 353  )))|(((
354 354  Id of the Jenkins Credentials for signers private keyfile.
355 355  )))
356 -|=(% colspan="1" rowspan="12" %)(((
359 +|=(% colspan="1" rowspan="8" %)(((
357 357  Static Source Code Analysis
358 358  )))|(((
359 359  checkstyleConfig
... ... @@ -378,29 +378,7 @@
378 378  )))|(((
379 379   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"]].
380 380  )))
381 -|skipDependencyCheck|false|Set to true to skip the dependency-check.
382 382  |(((
383 -dependencyCheckTool
384 -)))|(((
385 -'dependency-check'
386 -)))|(((
387 -Defines which named dependency-check tool should be used.
388 -)))
389 -|(((
390 -dependencyCheckArgs
391 -)))|(((
392 -'~-~-disableAssembly ~-~-nvdValidForHours 720'
393 -)))|(((
394 -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.
395 -)))
396 -|(((
397 -dependencyCheckNvdApiKeyCredentialsId
398 -)))|(((
399 -'dependency-check-nvdapikey'
400 -)))|(((
401 -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.
402 -)))
403 -|(((
404 404  sonarQube
405 405  )))|(((
406 406  true for the defaultBranch and for pull-requests, if a SonarQube version is detected which supports scanning multiple branches
... ... @@ -451,6 +451,13 @@
451 451  |sonarQualityGate| |Sets the desired quality gate to use for the scan result in SonarQube.
452 452  If not specified, the quality gate is not changed.
453 453  As a default, SonarQube will use the quality gate "Sonar way" for new scan results.
435 +|=(% colspan="1" rowspan="5" %)Dependency Check|skipDependencyCheck|false|Set to true to skip the dependency-check.
436 +|dependencyCheckTool|'dependency-check'|Defines which named dependency-check tool should be used.
437 +|dependencyCheckMvnArgs|'-DassemblyAnalyzerEnabled=false'|Additional arguments which are be passed to dependency-check for maven projects.(((
438 +See [[Dependency Check Maven Configuration>>https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html]] for more information.
439 +)))
440 +|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.
441 +|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.
454 454  |=(% colspan="1" rowspan="2" %)Dependency Track|depTrackCredentialsId|'PROJECTKEY-deptrack-projectcreator'|(((
455 455  Id of the Jenkins Credential which has to be used to authenticate to Dependency Track for publishing the SBOM.
456 456  )))
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