Overview
HOWTOs
Deprecated

nbm:build-installers

Full name:

org.netbeans.maven:nbm-maven-plugin:4.2-SNAPSHOT:build-installers

Description:

Build installers for Mavenized NetBeans application. Creates installers for supported operating systems and packages each installer as a deployable artifact.

See a how-to on customizing the installer.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
brandingToken String - The branding token for the application based on NetBeans platform.
User property is: netbeans.branding.token.
outputDirectory File - output directory.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
finalName String - Name of the zip artifact used to produce installers from (without .zip extension)
Default value is: ${project.build.finalName}.
installDirName String - Installation directory name at the destination system Deprecated, to be removed, was never actually used.
User property is: netbeans.branding.token.
installerLicenseFile File - License file
Default value is: ${basedir}/license.txt.
installerOsLinux boolean - Create installer for Linux
Default value is: true.
installerOsMacosx boolean - Create installer for MacOSx
Default value is: true.
installerOsSolaris boolean - Create installer for Solaris
Default value is: true.
installerOsWindows boolean - Create installer for Windows
Default value is: true.
installerPack200Enable boolean - Enable Pack200 compression
Default value is: true.
installersFilePrefix String - Prefix of all generated installers files
Default value is: ${project.build.finalName}.
templateFile File - Custom installer template. This file, if provided, will replace default template from <NetBeansInstallation>/harness/nbi/stub/template.xml
userSettings Map - Parameters passed to templateFile or to installer/nbi/stub/template.xml to customize generated installers.

Parameter Details

brandingToken:

The branding token for the application based on NetBeans platform.
  • Type: java.lang.String
  • Required: Yes
  • User Property: netbeans.branding.token

finalName:

Name of the zip artifact used to produce installers from (without .zip extension)
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.finalName}

installDirName:

Installation directory name at the destination system Deprecated, to be removed, was never actually used.
  • Type: java.lang.String
  • Required: No
  • User Property: netbeans.branding.token

installerLicenseFile:

License file
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/license.txt

installerOsLinux:

Create installer for Linux
  • Type: boolean
  • Required: No
  • Default: true

installerOsMacosx:

Create installer for MacOSx
  • Type: boolean
  • Required: No
  • Default: true

installerOsSolaris:

Create installer for Solaris
  • Type: boolean
  • Required: No
  • Default: true

installerOsWindows:

Create installer for Windows
  • Type: boolean
  • Required: No
  • Default: true

installerPack200Enable:

Enable Pack200 compression
  • Type: boolean
  • Required: No
  • Default: true

installersFilePrefix:

Prefix of all generated installers files
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.finalName}

outputDirectory:

output directory.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

templateFile:

Custom installer template. This file, if provided, will replace default template from <NetBeansInstallation>/harness/nbi/stub/template.xml
  • Type: java.io.File
  • Required: No

userSettings:

Parameters passed to templateFile or to installer/nbi/stub/template.xml to customize generated installers.
  • Type: java.util.Map
  • Required: No