You've already forked sap-jenkins-library
mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-11-29 22:58:09 +02:00
Revamp documentation generation for golang steps (#1781)
* Revamp documentation generation for golang steps * Add and update tests * Add tests, add step outputs * Add tests, add step outputs * Update rendering * fix merge conflict * update generated files * Update pkg/config/stepmeta.go * Update pkg/config/stepmeta.go * Update pkg/generator/helper/docuHelper.go Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> * Include PR feedback * update tests * Fix Jenkins dependecy indication Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
This commit is contained in:
@@ -2,24 +2,6 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
none
|
||||
|
||||
## Example
|
||||
|
||||
### Jenkins pipelines
|
||||
|
||||
```groovy
|
||||
artifactPrepareVersion script: this, buildTool: 'maven'
|
||||
```
|
||||
|
||||
### Command line
|
||||
|
||||
```
|
||||
piper artifactPrepareVersion --buildTool maven
|
||||
```
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -11,12 +11,6 @@ You need to store the API token for the Detect service as _'Secret text'_ creden
|
||||
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
```groovy
|
||||
detectExecuteScan script: this, scanProperties: ['--logging.level.com.synopsys.integration=TRACE']
|
||||
```
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
Reference in New Issue
Block a user