diff --git a/documentation/docs/steps/toolValidate.md b/documentation/docs/steps/toolValidate.md deleted file mode 100644 index ae32a1eb4..000000000 --- a/documentation/docs/steps/toolValidate.md +++ /dev/null @@ -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' -``` diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 493868652..44cd4b87f 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -34,7 +34,6 @@ nav: - slackSendNotification: steps/slackSendNotification.md - snykExecute: steps/snykExecute.md - testsPublishResults: steps/testsPublishResults.md - - toolValidate: steps/toolValidate.md - transportRequestCreate: steps/transportRequestCreate.md - transportRequestRelease: steps/transportRequestRelease.md - transportRequestUploadFile: steps/transportRequestUploadFile.md