mbt 1.2.13 → 1.2.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -111
  2. package/index.js +1 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -35,117 +35,30 @@ This demo shows the basic usage of the tool. For more advanced scenarios, follow
35
35
  <img src="./docs/demo.gif" width="100%">
36
36
  </p>
37
37
 
38
- #### The Cloud MTA Build Tool Images
39
- We supply serveral images for **CI environment** containg the Cloud MTA Build Tool. The images are hosted at [Github container registry](https://github.com/orgs/SAP/packages?tab=packages&q=mbtci-) and also at [Docker Hub registry](https://hub.docker.com/search?q=mbtci-&type=image).
40
- The images are built from template docker files which depend on most common technologies (Java and Node) as follows:
41
- * [mbtci-java8-node12](https://hub.docker.com/r/devxci/mbtci-java8-node12) is built from [Dockerfile_mbtci_java8](https://github.com/SAP/cloud-mta-build-tool/blob/master/Dockerfile_mbtci_java8) using Node 12.
42
- * [mbtci-java8-node14](https://hub.docker.com/r/devxci/mbtci-java8-node14) is built from [Dockerfile_mbtci_java8](https://github.com/SAP/cloud-mta-build-tool/blob/master/Dockerfile_mbtci_java8) using Node 14.
43
- * [mbtci-java11-node12](https://hub.docker.com/r/devxci/mbtci-java11-node12) is built from [Dockerfile_mbtci_java11](https://github.com/SAP/cloud-mta-build-tool/blob/master/Dockerfile_mbtci_java11) using Node 12.
44
- * [mbtci-java11-node14](https://hub.docker.com/r/devxci/mbtci-java11-node14) is built from [Dockerfile_mbtci_java11](https://github.com/SAP/cloud-mta-build-tool/blob/master/Dockerfile_mbtci_java14) using Node 14.
45
-
46
- Additional image which is more light-weight and gives the flexibility to add "per-scenario" the required set of tools:
47
- * [mbtci-alpine](https://hub.docker.com/r/devxci/mbtci-alpine) is built from [Dockerfile_mbtci_alpine](https://github.com/SAP/cloud-mta-build-tool/blob/master/Dockerfile_mbtci_alpine).
48
-
49
- ##### How to pull the images
50
- You should choose the relevant image type from following list to replace the `<TYPE>` template in the command/FROM according your MTA project technologies:
51
- * java8-node12
52
- * java8-node14
53
- * java11-node12
54
- * java11-node14
55
- * alpine
56
-
57
- From the command line:
58
- ```
59
- $ docker pull devxci/mbtci-<TYPE>:latest
60
- ```
61
- or
62
- ```
63
- $ docker pull ghcr.io/sap/mbtci-<TYPE>:latest
64
- ```
65
-
66
- From Dockerfile as a base image:
67
- ```
68
- FROM devxci/mbtci-<TYPE>:latest
69
- ```
70
- or
71
- ```
72
- FROM ghcr.io/sap/mbtci-<TYPE>:latest
73
- ```
74
-
75
- E.g. if your MTA project uses Java 11 and Node 14 then you should pull the relevant image as follows:
76
-
77
- From the command line:
78
- ```
79
- $ docker pull devxci/mbtci-java11-node14:latest
80
- ```
81
- or
82
- ```
83
- $ docker pull ghcr.io/sap/mbtci-java11-node14:latest
84
- ```
85
-
86
- From Dockerfile as a base image:
87
- ```
88
- FROM devxci/mbtci-java11-node14:latest
89
- ```
90
- or
91
- ```
92
- FROM ghcr.io/sap/mbtci-java11-node14:latest
93
- ```
94
-
95
- ##### How to use the images
96
- You should choose the relevant image type from following list to replace the `<TYPE>` template in the command according your MTA project technologies:
97
- * java8-node14
98
- * java8-node16
99
- * java8-node18
100
- * java11-node14
101
- * java11-node16
102
- * java11-node18
103
- * alpine
104
-
105
- On a Linux/Darwin machine you can run:
106
- ```
107
- docker run -it --rm -v "$(pwd)/[proj-releative-path]:/project" devxci/mbtci-<TYPE>:latest mbt build -p=cf -t [target-folder-name]
108
- ```
109
- This will build an mtar file for SAP Cloud Platform (Cloud Foundry). The folder containing the project needs to be mounted into the image at /project.
110
-
111
- <b>Note:</b> The parameter `-p=cf` can be omitted as the build for cloud foundry is the default build, this is an example of the MBT build parameters, for further commands see MBT docs.
112
-
113
- ##### How to build the images
114
- To build the images, you should choose the relevant docker file type from following list to replace the `<TYPE>` template in the Dockerfile according your MTA project Java version:
115
- * java8
116
- * java11
117
-
118
- Copy the docker file template:
119
- ```
120
- cp Dockerfile_<TYPE> Dockerfile
121
- ```
122
- E.g. copy the docker file used for Java 8:
123
- ```
124
- cp Dockerfile_java8 Dockerfile
125
- ```
126
- Replace `NODE_VERSION_TEMPLATE` with your Node version in the Dockerfile:
127
- ```
128
- ARG NODE_VERSION=NODE_VERSION_TEMPLATE
129
- ```
130
- Then you can build the image:
131
- ```
132
- docker build -t devxci/mbtci .
133
- ```
134
-
135
- To build the mbtci-alpine image you can run:
136
- ```
137
- docker build -f Dockerfile_alpine -t devxci/mbtci .
138
- ```
139
-
140
- ##### The images provide:
141
-
142
- - Cloud MTA Build Tool - 1.2.13
143
- - Nodejs - 14.19.2 or 16.15.0 or 18.1.0
144
- - Maven - 3.6.3
145
- - Golang - 1.14.7
146
- - Java - 8 or 11
147
-
148
- The MTA Archive Builder delegates module builds to other native build tools. These images provide Node.js, Maven, Java, and Golang so the archive builder can delegate to these build technologies. In case other build tools are needed, <b>inherit</b> from one of these images and add more build tools.
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 (**deprecated**)
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
+ These images are **no longer updated** and consumers are expected to create their own docker images (if necessary...).
51
+
52
+ This is because as a general purpose build orchestration tool MBT **cannot** and **should not** manage all the possible
53
+ build environments for its consumers as every consumer may have a different set of build "targets" and environment settings.
54
+
55
+ For reference, you may inspect the deprecated `dockerFiles`:
56
+ - [Pure Alpine](https://github.com/SAP/cloud-mta-build-tool/blob/42bed9a0f36de43f7575a3a743e2ba9c2449d975/Dockerfile_mbtci_alpine)
57
+ - [Java8 + NodeJS wildcard](https://github.com/SAP/cloud-mta-build-tool/blob/42bed9a0f36de43f7575a3a743e2ba9c2449d975/Dockerfile_mbtci_java8)
58
+ - [Java11 + NodeJS wildcard](https://github.com/SAP/cloud-mta-build-tool/blob/42bed9a0f36de43f7575a3a743e2ba9c2449d975/Dockerfile_mbtci_java11))
59
+
60
+ The Pure Alpine sample is of particular interest as it demonstrates [a simple way](https://github.com/SAP/cloud-mta-build-tool/blob/42bed9a0f36de43f7575a3a743e2ba9c2449d975/Dockerfile_mbtci_alpine#L8-L11)
61
+ to download, extract, "install" the `mbt` executable via `curl`, `tar` and `chown` commands.
149
62
 
150
63
  ##### License
151
64
 
package/index.js CHANGED
@@ -14,6 +14,7 @@ module.exports = binwrap({
14
14
  'darwin-arm64': root + 'Darwin_arm64.tar.gz',
15
15
  'darwin-x64': root + 'Darwin_amd64.tar.gz',
16
16
  'linux-x64': root + 'Linux_amd64.tar.gz',
17
+ 'linux-arm64': root + 'Linux_arm64.tar.gz',
17
18
  'win32-x64': root + 'Windows_amd64.tar.gz'
18
19
  }
19
20
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mbt",
3
- "version": "1.2.13",
3
+ "version": "1.2.18",
4
4
  "description": "[![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) [![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) [![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) ![GitHub license](https://img.shields.io/badge/license-Apache_2.0-blue.svg) ![pre-alpha](https://img.shields.io/badge/Release-pre--alpha-orange.svg)",
5
5
  "main": "index.js",
6
6
  "files": [