github.com/SAP/cloud-mta-build-tool@v1.2.27/README.md (about)

     1  
     2  <p align="center"><img width="350" height="281" src="logo.png" alt="MBT logo"></p>
     3  
     4  <br />
     5  
     6  [![CircleCI](https://circleci.com/gh/SAP/cloud-mta-build-tool.svg?style=svg&circle-token=ecedd1dce3592adcd72ee4c61481972c32dcfad7)](https://circleci.com/gh/SAP/cloud-mta-build-tool)
     7  [![Go Report Card](https://goreportcard.com/badge/github.com/SAP/cloud-mta-build-tool)](https://goreportcard.com/report/github.com/SAP/cloud-mta-build-tool)
     8  [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3400/badge)](https://bestpractices.coreinfrastructure.org/projects/3400) 
     9  [![Coverage Status](https://coveralls.io/repos/github/SAP/cloud-mta-build-tool/badge.svg?branch=cover)](https://coveralls.io/github/SAP/cloud-mta-build-tool?branch=cover)
    10  ![Beta](https://img.shields.io/badge/version-v1-green)
    11  [![GitHub stars](https://img.shields.io/badge/contributions-welcome-orange.svg)](docs/docs/process.md)
    12  [![dependentbot](https://api.dependabot.com/badges/status?host=github&repo=SAP/cloud-mta-build-tool)](https://dependabot.com/)
    13  [![REUSE status](https://api.reuse.software/badge/github.com/SAP/cloud-mta-build-tool)](https://api.reuse.software/info/github.com/SAP/cloud-mta-build-tool)
    14  
    15  
    16  ## Description
    17  
    18  #### Multi-Target Application
    19  
    20  Before using this package, make sure that you are familiar with the multi-target application concept and terminology. For background and detailed information, see the [Multi-Target Application Model](https://www.sap.com/documents/2016/06/e2f618e4-757c-0010-82c7-eda71af511fa.html) guide. 
    21  
    22  #### The Cloud MTA Build Tool Overview
    23  The Cloud MTA Build Tool is a standalone command-line tool that builds a deployment-ready
    24  multitarget application (MTA) archive `.mtar` file from the artifacts of an MTA project according to the project’s MTA
    25  development descriptor (`mta.yaml` file) or from module build artifacts according to the MTA deployment descriptor (`mtad.yaml` file). Also, it provides commands for running intermediate build process steps; for example, the `mta.yaml` file validations, building a single module according to the configurations in the development descriptor, generating the deployment descriptor, and so on.
    26  
    27  
    28  ><b>For more information, see the [Cloud MTA Build Tool user guide](https://sap.github.io/cloud-mta-build-tool/)</b>
    29  
    30  #### Demo
    31  
    32  This demo shows the basic usage of the tool. For more advanced scenarios, follow the documentation.
    33  
    34  <p align="center">
    35    <img src="./docs/demo.gif" width="100%">
    36  </p>
    37  
    38  #### Install
    39  
    40  For convenience the `mbt` executable is available via npmjs.com so consumers using a nodejs runtime can simply run:
    41  - `npm install -g mbt@version`
    42  - For possible versions see: https://www.npmjs.com/package/mbt?activeTab=versions
    43  
    44  It is also possible to download and "install" the `mbt` executable via github releases.
    45  - See: https://github.com/SAP/cloud-mta-build-tool/releases.
    46  
    47  #### The Cloud MTA Build Tool Images
    48  
    49  The Cloud MTA Build Tool published docker images on docker hub with a pre-configured set of runtime tools (nodejs/java/maven/...).
    50  
    51  ## Node.js v10 and lower minor version of Node.js v11, v12, v13  /ECMAScript modules
    52  
    53  More and more npm packages use ECMAScript modules instead of commonJS, for ECMAScript modules are the official standard format to package JavaScript code for reuse. From v1.2.25, we use axios instead of binwrap(which has moderate severity vulnerabilities) to download binary files, but axios only supports ECMAScript modules and can't work on Node.js v10 and lower minor version of Node.js v11, v12, v13. The axios can work on latest version of Node.js v11.15, v12.22, v13.14.  So since v1.2.25, mbt will not support Node.js v10 and lower versions, including lower minor version of Node.js v11, v12, v13.
    54  
    55  ## License
    56  
    57  Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.
    58  Please note that Docker images can contain other software which may be licensed under different licenses. This License file is also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.
    59  
    60  ## Contributions
    61  
    62  Contributions are greatly appreciated.
    63  If you want to contribute, follow [the guidelines](docs/docs/process.md).
    64  
    65  ## Support
    66  
    67  Please follow our [issue template](https://github.com/SAP/cloud-mta-build-tool/issues/new/choose) on how to report an issue.