jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-01-30 05:59:39 +02:00
Code Issues Releases Activity

Docu update mtaBuild

Browse Source
This commit is contained in:
Marcus Holl 2018-02-27 10:07:43 +01:00
parent b51a747fcb
commit 6e1a1245e8
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
documentation/docs/steps/mtaBuild.md
View File

@ -9,15 +9,15 @@ Executes the SAP MTA Archive Builder to create an mtar archive of the applicatio
* **NodeJS installed** - the MTA Builder uses `npm` to download node module dependencies such as `grunt`.
## Parameters
| parameter | mandatory | default | possible values |
| -----------------|-----------|-----------------------------------|--------------------|
| `script` | yes | | |
| `buildTarget` | yes | | 'CF', 'NEO', 'XSA' |
| `mtaJarLocation` | no | | |
| parameter | mandatory | default | possible values |
| -----------------|-----------|--------------------------------------------------------|--------------------|
| `script` | yes | | |
| `buildTarget` | yes | `'buildTarget'` from step configuration `'mtaBuild'` | 'CF', 'NEO', 'XSA' |
| `mtaJarLocation` | no | `'mtaJarLocation'`from step configuration `'mtaBuild'` | |
* `script` - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the `this` parameter, as in `script: this`. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters.
* `buildTarget` - The target platform to which the mtar can be deployed.
* `mtaJarLocation` - The path of the `mta.jar` file. If no parameter is provided, the path is retrieved from the Jenkins environment variables using `env.MTA_JAR_LOCATION`. If the Jenkins environment variable is not set it is assumed that `mta.jar` is located in the current working directory.
* `mtaJarLocation` - The path of the `mta.jar` file. If no parameter is provided, neither at the level of the method call nor via step configuration, the path is retrieved from the Jenkins environment variables using `env.MTA_JAR_LOCATION`. If the Jenkins environment variable is not set it is assumed that `mta.jar` is located in the current working directory.
## Return value
The file name of the resulting archive is returned with this step. The file name is extracted from the key `ID` defined in `mta.yaml`.