jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Code Issues Releases Activity
a7f1ec0bad
sap-jenkins-library/documentation/docs/steps/toolValidate.md
Oliver Feldmann 8e70c72ea9 Documentation improvements 
Slight improvements on various md files.
Deletion of method-based commonPipelineEnvironment documentation as it
is not used.
2017-12-06 13:24:01 +01:00

1.0 KiB
Raw Blame History

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.

Return value

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

toolValidate tool: 'neo', home:'/path/to/neo-java-web-sdk'