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

Fix docu template

Browse Source
This commit is contained in:
Sven Merk 2019-03-27 11:49:56 +01:00
parent ae083f5aa7
commit 6c85699689
1 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/docs/steps/whitesourceExecuteScan.md
View File

@ -1,20 +1,16 @@
# whitesourceExecuteScan
# ${docGenStepName}
## Description
Content here is generated from corresponding step, see `vars`.
## ${docGenDescription}
## Prerequisites
None
Your company has registered an account with WhiteSource and you have enabled the use of so called `User Keys` to manage
access to your organization in WhiteSource via dedicated privileges. Scanning your products without adequate user level
access protection imposed on the WhiteSource backend would simply allow access based on the organization token.
## Parameters
## ${docGenParameters}
Content here is generated from corresponding step, see `vars`.
## Step configuration
Content here is generated from corresponding step, see `vars`.
## ${docGenConfiguration}
## Exceptions
@ -23,5 +19,5 @@ None
## Examples
```groovy
whitesourceExecuteScan script: this, scanType: 'pip', productName: 'My Whitesource Product', userTokenCredentialsId: 'companyAdminToken', orgAdminUserTokenCredentialsId: 'orgAdmiToken', orgToken: 'myWhitesourceOrganizationToken'
whitesourceExecuteScan script: this, scanType: 'pip', productName: 'My Whitesource Product', userTokenCredentialsId: 'companyAdminToken', orgAdminUserTokenCredentialsId: 'orgAdminToken', orgToken: 'myWhitesourceOrganizationToken'
```