jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-01-18 05:18:24 +02:00
Code Issues Releases Activity

fix(docs): typo in sample parameter (#2433)

Browse Source 
* fix typo

* add code blocks
This commit is contained in:
Christopher Fenner 2020-11-30 08:57:48 +01:00 committed by GitHub
parent c09c5e1ef0
commit c9e2a09ca1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
documentation/docs/steps/checksPublishResults.md
View File

@ -5,8 +5,7 @@
## Prerequisites ## Prerequisites
* **static check result files** - To use this step, there must be static check result files available. * **static check result files** - To use this step, there must be static check result files available.
* installed plugins: * installed [warnings-ng](https://plugins.jenkins.io/warnings-ng/) plugin
* [warnings-ng](https://plugins.jenkins.io/warnings-ng/)
## ${docGenParameters} ## ${docGenParameters}
@ -23,7 +22,7 @@ deprecated, do not use
| high | no | `'FIXME'` | | | high | no | `'FIXME'` | |
| normal | no | `'TODO,REVISE,XXX'` | | | normal | no | `'TODO,REVISE,XXX'` | |
| low | no | | | | low | no | | |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
### pmd ### pmd
@ -31,7 +30,7 @@ deprecated, do not use
| ----------|-----------|---------|-----------------| | ----------|-----------|---------|-----------------|
| pattern | no | `'**/target/pmd.xml'` | | | pattern | no | `'**/target/pmd.xml'` | |
| archive | no | `true` | `true`, `false` | | archive | no | `true` | `true`, `false` |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
### cpd ### cpd
@ -39,7 +38,7 @@ deprecated, do not use
| ----------|-----------|---------|-----------------| | ----------|-----------|---------|-----------------|
| pattern | no | `'**/target/cpd.xml'` | | | pattern | no | `'**/target/cpd.xml'` | |
| archive | no | `true` | `true`, `false` | | archive | no | `true` | `true`, `false` |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
### findbugs ### findbugs
@ -47,7 +46,7 @@ deprecated, do not use
| ----------|-----------|---------|-----------------| | ----------|-----------|---------|-----------------|
| pattern | no | `'**/target/findbugsXml.xml, **/target/findbugs.xml'` | | | pattern | no | `'**/target/findbugsXml.xml, **/target/findbugs.xml'` | |
| archive | no | `true` | true, false | | archive | no | `true` | true, false |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
### checkstyle ### checkstyle
@ -55,7 +54,7 @@ deprecated, do not use
| ----------|-----------|---------|-----------------| | ----------|-----------|---------|-----------------|
| pattern | no | `'**/target/checkstyle-result.xml'` | | | pattern | no | `'**/target/checkstyle-result.xml'` | |
| archive | no | `true` | `true`, `false` | | archive | no | `true` | `true`, `false` |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
### eslint ### eslint
@ -63,7 +62,7 @@ deprecated, do not use
| ----------|-----------|---------|-----------------| | ----------|-----------|---------|-----------------|
| pattern | no | `'**/eslint.jslint.xml'` | | | pattern | no | `'**/eslint.jslint.xml'` | |
| archive | no | `true` | `true`, `false` | | archive | no | `true` | `true`, `false` |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
### pylint ### pylint
@ -71,7 +70,7 @@ deprecated, do not use
| ----------|-----------|---------|-----------------| | ----------|-----------|---------|-----------------|
| pattern | no | `'**/pylint.log'` | | | pattern | no | `'**/pylint.log'` | |
| archive | no | `true` | `true`, `false` | | archive | no | `true` | `true`, `false` |
| qualityGates | no | [[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]] | see [QualityGates](#qualitygates) | | qualityGates | no | `[[threshold: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_ERROR', unstable: false]]` | see [QualityGates](#qualitygates) |
## ${docGenConfiguration} ## ${docGenConfiguration}
@ -83,10 +82,10 @@ It is possible to define quality gates to set the build result to `FAILURE` (not
```groovy ```groovy
qualityGates: [ qualityGates: [
[thresholds: 1, type: 'TOTAL_HIGH', unstable: false], [threshold: 1, type: 'TOTAL_HIGH', unstable: false],
[thresholds: 10, type: 'TOTAL_NORMAL', unstable: false], [threshold: 10, type: 'TOTAL_NORMAL', unstable: false],
[thresholds: 100, type: 'TOTAL_LOW', unstable: false], [threshold: 100, type: 'TOTAL_LOW', unstable: false],
[thresholds: 1000, type: 'TOTAL', unstable: false], [threshold: 1000, type: 'TOTAL', unstable: false],
] ]
``` ```