jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-16 11:09:33 +02:00
Code Issues Releases Activity
09e4e999a2
sap-jenkins-library/documentation/docs/steps/mtaBuild.md
Florian Wilhelm 50ac5b0ac9
Execute MTA builder in Docker
2018-09-04 11:32:54 +02:00

4.7 KiB
Raw Blame History

mtaBuild

Description

Executes the SAP Multitarget Application Archive Builder to create an mtar archive of the application.

Before doing this, validates that SAP Multitarget Application Archive Builder exists and the version is compatible.

Note that a version is formed by major.minor.patch, and a version is compatible to another version if the minor and patch versions are higher, but the major version is not, e.g. if 3.39.10 is the expected version, 3.39.11 and 3.40.1 would be compatible versions, but 4.0.1 would not be a compatible version.

Prerequisites

  • A docker image meeting the following requirements
    • SAP MTA Archive Builder 1.0.6 or compatible version - can be downloaded from SAP Development Tools.
    • Java 8 or compatible version - necessary to run the mta.jar file.
    • NodeJS installed - the MTA Builder uses npm to download node module dependencies such as grunt.

Parameters

parameter mandatory default possible values
script yes
dockerImage yes
dockerOptions no ''
buildTarget yes 'NEO' 'CF', 'NEO', 'XSA'
extension no
mtaJarLocation no 'mta.jar'
applicationName no
  • 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 for retrieving, for example, configuration parameters.
  • dockerImage - The Docker image to execute the MTA build. A custom built image needs to include Multi-target Application Archive Builder. Refer to SAP Help Portal for information on how to set it up.
  • dockerOptions Docker options to be set when starting the container. It can be a list or a string.
  • buildTarget - The target platform to which the mtar can be deployed.
  • extension - The path to the extension descriptor file.
  • mtaJarLocation - The location of the SAP Multitarget Application Archive Builder jar file, including file name and extension. First, the location is retrieved from the environment variables using the environment variableMTA_JAR_LOCATION. If no environment variable is provided, the location is retrieved from the parameters, or the step configuration using the key mtaJarLocation. If SAP Multitarget Application Archive Builder is not found on one of the previous locations an AbortException is thrown. Note that the environment variable MTA_JAR_LOCATION has priority. In case that the script runs on multiple nodes, SAP Multitarget Application Archive Builder must be located on all the nodes, therefore the environment variable must be also configured on all the nodes.
  • applicationName - The name of the application which is being built. If the parameter has been provided and no mta.yaml exists, the mta.yaml will be automatically generated using this parameter and the information (name and version) from package.json before the actual build starts.

Step configuration

The following parameters can also be specified as step parameters using the global configuration file:

  • dockerImage
  • buildTarget
  • extension
  • mtaJarLocation
  • applicationName

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.

Side effects

  1. The file name of the resulting archive is written to the commonPipelineEnvironment with variable name mtarFileName.

Exceptions

  • AbortException:
    • If SAP Multitarget Application Archive Builder is not found.
    • If there is an invalid buildTarget.
    • If there is no key ID inside the mta.yaml file.

Example

def mtarFileName
dir('/path/to/FioriApp'){
  mtarFileName = mtaBuild script:this, buildTarget: 'NEO'
}