install4j:compile
Full name:
org.sonatype.install4j:install4j-maven-plugin:1.1.2:compile
Description:
Compile installers (via install4jc). Execution will skip if
install4j.home location is invalid.
Attributes:
- Requires a Maven project to be executed.
- Since version: 1.0.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| projectFile | File | 1.0 | install4j project file. User property is: install4j.projectFile. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| appleIdPassword | String | 1.0 | Set the app-specific password for notarizing macOS media files.
This only has an effect when run on a macOS machine. User property is: install4j.appleIdPassword. |
| attach | boolean | 1.0 | Attach generated installers. Uses the media id as the classifier. Default value is: false. User property is: install4j.attach. |
| buildIds | String | 1.0 | Only build the media files with the specified IDs. User property is: install4j.buildIds. |
| buildSelected | boolean | 1.0 | Only build the media files which have been selected in the
install4j IDE. Default value is: false. User property is: install4j.buildSelected. |
| debug | boolean | 1.0 | Create additional debug installers for each media file. Default value is: false. User property is: install4j.debug. |
| destination | File | 1.0 | The output directory for the generated media files. Default value is: ${project.build.directory}/media. User property is: install4j.destination. |
| disableBundling | boolean | 1.0 | Disable JRE bundling. Default value is: false. User property is: install4j.disableBundling. |
| disableSigning | boolean | 1.0 | Disable code signing. Default value is: false. User property is: install4j.disableSigning. |
| failIfMissing | boolean | 1.0 | Fail if the installation is missing. Default value is: false. User property is: install4j.failIfMissing. |
| faster | boolean | 1.0 | Disable LZMA and Pack200 compression. Default value is: false. User property is: install4j.faster. |
| incremental | boolean | 1.0 | Enables incremental test execution. Default value is: false. User property is: install4j.incremental. |
| installDir | File | 1.0 | The location of the install4j installation. User property is: install4j.home. |
| jvmArguments | List | 1.0 | Set custom jvm arguments on compiler. |
| macKeystorePassword | String | 1.0 | Set the Mac OSX keystore password for the private key that is
configured for code signing. User property is: install4j.macKeystorePassword. |
| mediaTypes | String | 1.0 | Only build media files of the specified type. User property is: install4j.mediaTypes. |
| preserve | boolean | 1.0 | Preserve temporary staging directory. Default value is: false. User property is: install4j.preserve. |
| quiet | boolean | 1.0 | Enables quiet mode. In quiet mode, no terminal output short of a
fatal error will be printed. Default value is: false. User property is: install4j.quiet. |
| release | String | 1.0 | Override the application version. Default value is: ${project.version}. User property is: install4j.release. |
| skip | boolean | 1.0 | Skip execution. Default value is: false. User property is: install4j.skip. |
| test | boolean | 1.0 | Enables test mode. In test mode, no media files will be generated
in the media file directory. Default value is: false. User property is: install4j.test. |
| variableFile | File | 1.0 | Load variable definitions from a file. User property is: install4j.variableFile. |
| variables | Properties | 1.0 | Override compiler variables with a different values. |
| variablesTempFile | File | 1.0 | File where custom variables are written to pass to install4j. Default value is: ${project.build.directory}/install4j-variables.txt. |
| verbose | boolean | 1.0 | Enables verbose mode. In verbose mode, install4j prints out
information about internal processes. Default value is: false. User property is: install4j.verbose. |
| winKeystorePassword | String | 1.0 | Set the Windows keystore password for the private key that is
configured for code signing. User property is: install4j.winKeystorePassword. |
Parameter Details
Set the app-specific password for notarizing macOS media files.
This only has an effect when run on a macOS machine.
- Type: java.lang.String
- Since: 1.0
- Required: No
- User Property: install4j.appleIdPassword
Attach generated installers. Uses the media id as the classifier.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.attach
- Default: false
Only build the media files with the specified IDs.
- Type: java.lang.String
- Since: 1.0
- Required: No
- User Property: install4j.buildIds
Only build the media files which have been selected in the
install4j IDE.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.buildSelected
- Default: false
Create additional debug installers for each media file.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.debug
- Default: false
The output directory for the generated media files.
- Type: java.io.File
- Since: 1.0
- Required: No
- User Property: install4j.destination
- Default: ${project.build.directory}/media
Disable JRE bundling.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.disableBundling
- Default: false
Disable code signing.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.disableSigning
- Default: false
Fail if the installation is missing.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.failIfMissing
- Default: false
Disable LZMA and Pack200 compression.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.faster
- Default: false
Enables incremental test execution.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.incremental
- Default: false
The location of the install4j installation.
- Type: java.io.File
- Since: 1.0
- Required: No
- User Property: install4j.home
Set custom jvm arguments on compiler.
- Type: java.util.List
- Since: 1.0
- Required: No
Set the Mac OSX keystore password for the private key that is
configured for code signing.
- Type: java.lang.String
- Since: 1.0
- Required: No
- User Property: install4j.macKeystorePassword
Only build media files of the specified type.
- Type: java.lang.String
- Since: 1.0
- Required: No
- User Property: install4j.mediaTypes
Preserve temporary staging directory.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.preserve
- Default: false
install4j project file.
- Type: java.io.File
- Since: 1.0
- Required: Yes
- User Property: install4j.projectFile
Enables quiet mode. In quiet mode, no terminal output short of a
fatal error will be printed.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.quiet
- Default: false
Override the application version.
- Type: java.lang.String
- Since: 1.0
- Required: No
- User Property: install4j.release
- Default: ${project.version}
skip:
Skip execution.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.skip
- Default: false
test:
Enables test mode. In test mode, no media files will be generated
in the media file directory.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.test
- Default: false
Load variable definitions from a file.
- Type: java.io.File
- Since: 1.0
- Required: No
- User Property: install4j.variableFile
Override compiler variables with a different values.
- Type: java.util.Properties
- Since: 1.0
- Required: No
File where custom variables are written to pass to install4j.
- Type: java.io.File
- Since: 1.0
- Required: No
- Default: ${project.build.directory}/install4j-variables.txt
Enables verbose mode. In verbose mode, install4j prints out
information about internal processes.
- Type: boolean
- Since: 1.0
- Required: No
- User Property: install4j.verbose
- Default: false
Set the Windows keystore password for the private key that is
configured for code signing.
- Type: java.lang.String
- Since: 1.0
- Required: No
- User Property: install4j.winKeystorePassword