jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-09-16 09:26:22 +02:00
Code Issues Releases Activity

Add-on Build Pipeline: cause the current build to stop depending on ATC check quality gate (#3833)

Browse Source 
* Update extensibility.md

* Update abapEnvironmentAddons.md

* Update documentation/docs/pipelines/abapEnvironment/extensibility.md

Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>

* Update extensibility.md

Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>
This commit is contained in:
Peter Persiel
2022-08-12 16:03:44 +02:00
committed by GitHub
parent be565f1543
commit 5d2ab86674
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/docs/pipelines/abapEnvironment/extensibility.md
View File

@@ -34,6 +34,14 @@ While `tools: [checkStyle(pattern: '**/**/ATCResults.xml')]` will display the AT
You can define several quality gates that will be checked after the issues have been reported. For example by providing a `qualityGates` configuration with option `unstable: false` it would be possible to end the pipeline execution in case of findings. See [Quality gate configuration](https://github.com/jenkinsci/warnings-ng-plugin/blob/master/doc/Documentation.md#quality-gate-configuration) for details.
If the pipeline execution should be aborted in case of ATC findings, to not continue with execution of following pipeline stages, use the [error](https://www.jenkins.io/doc/pipeline/steps/workflow-basic-steps/#error-error-signal) step in the stage extension to cause the build to stop:
```groovy
if (currentBuild.result == 'FAILURE') {
error('Stopping build due to ATC Check quality gate')
}
```
!!! caution "Local Jenkins"
If you are using a local Jenkins you may have to [adapt the Jenkins URL](https://stackoverflow.com/a/39543223) in the configuration if the CheckStyle Plugin shows this error: "Can't create fingerprints for some files".

4
documentation/docs/scenarios/abapEnvironmentAddons.md
View File

@@ -138,9 +138,9 @@ Please refer to the [configuration page](../pipelines/abapEnvironment/configurat
#### ATC
!!! caution ""
We recommend to configure the add-on build pipeline with a __quality gate to block any priority 1 ATC findings__.
We recommend to configure the add-on build pipeline with a __quality gate to block any error and warning ATC findings__.
This can be configured with a quality gate configuration `[threshold: 1, type: 'TOTAL_ERROR', unstable: false]` in the `recordIssues` pipeline step shown in [Extend the ATC stage via the Checkstyle/Warnings Next Generation Plugin](https://www.project-piper.io/pipelines/abapEnvironment/extensibility/#1-extend-the-atc-stage-via-the-checkstylewarnings-next-generation-plugin).
This can be configured with a quality gate configuration `[threshold: 1, type: 'TOTAL_ERROR', unstable: false]` and `[threshold: 1, type: 'TOTAL_NORMAL', unstable: false]` in the `recordIssues` pipeline step shown in [Extend the ATC stage via the Checkstyle/Warnings Next Generation Plugin](https://www.project-piper.io/pipelines/abapEnvironment/extensibility/#1-extend-the-atc-stage-via-the-checkstylewarnings-next-generation-plugin).
Created delivery packages for an add-on product version are final, so to fix any errors in these packages, another add-on product version would have to be built.
ATC findings should be resolved during development as early as possible, e.g. [during transport release](https://help.sap.com/viewer/5371047f1273405bb46725a417f95433/Cloud/en-US/c0d95a9263da476eb5b6ae03225ce7ba.html) and by using an additional pipeline configured for the [Continuous Testing on SAP BTP, ABAP Environment scenario](abapEnvironmentTest.md).