Skip to content

Commit 5eb16e3

Browse files
authored
Merge pull request #10904 from GulamY/GulamY-add-portable-app-deployment-docs
Add portable app deployment option to MxBuild docs
2 parents f6305c1 + 18a921d commit 5eb16e3

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

content/en/docs/refguide/general/mxbuild.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Command-line options are described in the table below:
6868
| `-h`, `--help` | Prints a short description of the MxBuild and a list of all available options. |
6969
| `--java-home=DIRECTORY` | (Required). The directory in which the JDK is installed.<br/>For example, `--java-home=/usr/lib/jvm/java-8-oracle`.<br/>For Windows, *DIRECTORY* should be enclosed in double-quotes `"`. |
7070
| `--java-exe-path=FILENAME` | (Required). The full path to the Java executable.<br/>For example, `--java-exe-path=/usr/lib/jvm/java-8-oracle/bin/java`.<br/>For Windows, *DIRECTORY* should be enclosed in double-quotes `"` and must contain the complete file name `...\java.exe`. |
71-
| <code>––target=[package&#124;deploy]</code> | `package`: default if option is omitted; creates a deployment package (*.mda file*).<br/>`deploy`: deploys the app without making a deployment package.<br/>`sbom`: generates a [Software Bill of Materials](/refguide/sbom-generation/) (SBOM) in the CycloneDX format for the app. |
71+
| <code>––target=[package&#124;deploy&#124;sbom&#124;portable-app-package]</code> | `package`: default if option is omitted; creates a deployment package (*.mda file*).<br/>`deploy`: deploys the app without making a deployment package.<br/>`sbom`: generates a [Software Bill of Materials](/refguide/sbom-generation/) (SBOM) in the CycloneDX format for the app. <br/> `portable-app-package`: generates a portable app deployment zip file with components and configurations required to run the application.|
7272
| `--loose-version-check` | Creates a deployment package from an app which was created with a lower Mendix version.<br/>The app will be upgraded to the MxBuild version before the deployment package is created.<br /> Any changes included as a result of this upgrade will not be stored in your app. |
7373
| `--write-errors=FILENAME` | Writes all errors, warnings, and deprecations encountered during deployment of the app to the specified file in JSON format.<br />This file is only written when the app contains errors.<br />If the file already exists, it will be overwritten without a warning.<br />For a description of the format of this file, see the [App Errors](#app-errors) section below. |
7474
| `--generate-sbom` | Generates a Software Bill of Materials (SBOM) file as a part of the `package` and `deployment` targets. The SBOM will be included in the deployment package if this option is used and is saved under its default location: `deployment\sbom.json` |
@@ -115,6 +115,23 @@ For example, to create a SBOM in the deployment directory of the App with the na
115115
mxbuild --target=sbom --java-home="C:\Program Files\Java\jdk1.8.0_144" --java-exe-path="C:\Program Files\Java\jdk1.8.0_144\bin\java.exe" "C:\Users\username\Documents\Mendix\MyApp\MyApp.mpr"
116116
```
117117

118+
### Options When Creating a Portable App Package
119+
120+
{{% alert color="info" %}}
121+
The following options are only applicable to the `--target=portable-app-package` option, which is available for Studio Pro 11.9 and above.
122+
{{% /alert %}}
123+
124+
| Option | Description |
125+
| --- | --- |
126+
| `--export-secrets` | Emits passwords and private constants to the configuration files. |
127+
| `-o FILENAME` or<br/>`--output=FILENAME` | The name (with optional relative or absolute path) of the portable app deployment zip file. The extension of the file must be `.zip`. This option is mandatory.|
128+
129+
For example, to create a portable app deployment zip file in the target directory of the app with the name `MyApp_PAD.zip` for the application `MyApp` using the Windows version of MxBuild, you can use the following command:
130+
131+
```bat
132+
mxbuild --target=portable-app-package --java-home="C:\Program Files\Java\jdk1.8.0_144" --java-exe-path="C:\Program Files\Java\jdk1.8.0_144\bin\java.exe" -o "C:\Users\username\Documents\Mendix\MyApp\MyApp_PAD.zip" "C:\Users\username\Documents\Mendix\MyApp\MyApp.mpr"
133+
```
134+
118135
## Return Code
119136

120137
When MxBuild exits, one of the following codes will be returned:

0 commit comments

Comments
 (0)