1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00

remove documentation

This commit is contained in:
Alejandra Ferreiro Vidal 2019-03-26 17:19:57 +01:00
parent 6b98d642da
commit eba4c68a49
2 changed files with 0 additions and 42 deletions

View File

@ -1,41 +0,0 @@
# toolValidate
## Description
Checks the existence and compatibility of a tool, necessary for a successful pipeline execution.
In case a violation is found, an exception is raised.
## Prerequisites
none
## Parameters
| parameter | mandatory | default | possible values |
| -----------------|-----------|-----------------------------------|----------------------------|
| `tool` | yes | | 'java', 'mta', 'neo' |
| `home` | yes | | |
* `tool` The tool that is checked for existence and compatible version.
* `home` The location in the file system where Jenkins can access the tool.
## Step configuration
none
## Side effects
none
## Exceptions
* `IllegalArgumentException`:
* If at least one of the parameters `tool`, `home` is not provided.
* `AbortException`:
* If `tool` is not supported.
## Example
```groovy
toolValidate tool: 'neo', home:'/path/to/neo-java-web-sdk'
```

View File

@ -34,7 +34,6 @@ nav:
- slackSendNotification: steps/slackSendNotification.md - slackSendNotification: steps/slackSendNotification.md
- snykExecute: steps/snykExecute.md - snykExecute: steps/snykExecute.md
- testsPublishResults: steps/testsPublishResults.md - testsPublishResults: steps/testsPublishResults.md
- toolValidate: steps/toolValidate.md
- transportRequestCreate: steps/transportRequestCreate.md - transportRequestCreate: steps/transportRequestCreate.md
- transportRequestRelease: steps/transportRequestRelease.md - transportRequestRelease: steps/transportRequestRelease.md
- transportRequestUploadFile: steps/transportRequestUploadFile.md - transportRequestUploadFile: steps/transportRequestUploadFile.md