$i18n.getString(

eclipse-dmg-packager:package-dmg

Full name:

org.eclipse.cbi.maven.plugins:eclipse-dmg-packager:1.5.4-SNAPSHOT:package-dmg

Description:

Create a DMG file from the file specified as argument. This plug-in requires access to the Eclipse DMG packager web service.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
<serviceUrl> String 1.1.3 The URL for creating DMG files

The signing service return a dmg file of the application passed as a source.


Default: https://cbi.eclipse.org/macos/packager/dmg/create
User Property: cbi.dmgpackager.serviceUrl
<source> File 1.1.3 An .tar.gz or .zip file containing a single OS X application to create the DMG for.

Optional Parameters

Name Type Since Description
<backgroundImage> File 1.1.3 A png file for background image for the installer.
<continueOnFail> boolean 1.1.3 Whether the build should be stopped if the packaging process fails.
Default: false
User Property: cbi.dmgpackager.continueOnFail
<dropLinkPosition> String 1.1.3 Location of the drop link to Applications folder.
Default: 375 125
<eulaFile> File 1.1.3 File to attach as a license.
<icon> String 1.1.3 Name of the icon to display and position, e.g., "Eclipse.app x y". Recommended size 100 125
<iconSize> String 1.1.3 The size of the icon to display in the installer.
Default: 125
<sign> boolean 1.1.4 Controls signing of the dmg file
Default: false
User Property: cbi.dmgpackager.sign
<skip> boolean 1.1.3 Skips the execution of this plugin
Default: false
User Property: cbi.dmgpackager.skip
<target> File 1.1.3 Where the new DMG file should be saved. If it is not specified, the file is placed beside source.
<timeoutMillis> int 1.1.5 Determines the timeout in milliseconds for any communication with the packaging/signing server. A timeout value of zero is interpreted as an infinite timeout.
Default: 0
User Property: cbi.dmgpackager.timeoutMillis
<volumeIcon> File 1.1.3 The icns file used for the DMG.
<volumeName> String 1.1.3 The user readable name of the DMG created. It is displayed in the Finder sidebar and window title.
<windowPosition> String 1.1.3 The position of the installer window when it opens. Coordinates are expressed as X Y (e.g. 50 50).
Default: 50 50
<windowSize> String 1.1.3 The size of the installer window. Coordinates are expressed as X Y (e.g. 480 300)
Default: 480 300

Parameter Details

<backgroundImage>

A png file for background image for the installer.
  • Type: java.io.File
  • Since: 1.1.3
  • Required: No

<continueOnFail>

Whether the build should be stopped if the packaging process fails.
  • Type: boolean
  • Since: 1.1.3
  • Required: No
  • User Property: cbi.dmgpackager.continueOnFail
  • Default: false

<dropLinkPosition>

Location of the drop link to Applications folder.
  • Type: java.lang.String
  • Since: 1.1.3
  • Required: No
  • Default: 375 125

<eulaFile>

File to attach as a license.
  • Type: java.io.File
  • Since: 1.1.3
  • Required: No

<icon>

Name of the icon to display and position, e.g., "Eclipse.app x y". Recommended size 100 125
  • Type: java.lang.String
  • Since: 1.1.3
  • Required: No

<iconSize>

The size of the icon to display in the installer.
  • Type: java.lang.String
  • Since: 1.1.3
  • Required: No
  • Default: 125

<serviceUrl>

The URL for creating DMG files

The signing service return a dmg file of the application passed as a source.

  • Type: java.lang.String
  • Since: 1.1.3
  • Required: Yes
  • User Property: cbi.dmgpackager.serviceUrl
  • Default: https://cbi.eclipse.org/macos/packager/dmg/create

<sign>

Controls signing of the dmg file
  • Type: boolean
  • Since: 1.1.4
  • Required: No
  • User Property: cbi.dmgpackager.sign
  • Default: false

<skip>

Skips the execution of this plugin
  • Type: boolean
  • Since: 1.1.3
  • Required: No
  • User Property: cbi.dmgpackager.skip
  • Default: false

<source>

An .tar.gz or .zip file containing a single OS X application to create the DMG for.
  • Type: java.io.File
  • Since: 1.1.3
  • Required: Yes

<target>

Where the new DMG file should be saved. If it is not specified, the file is placed beside source.
  • Type: java.io.File
  • Since: 1.1.3
  • Required: No

<timeoutMillis>

Determines the timeout in milliseconds for any communication with the packaging/signing server. A timeout value of zero is interpreted as an infinite timeout.
  • Type: int
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.dmgpackager.timeoutMillis
  • Default: 0

<volumeIcon>

The icns file used for the DMG.
  • Type: java.io.File
  • Since: 1.1.3
  • Required: No

<volumeName>

The user readable name of the DMG created. It is displayed in the Finder sidebar and window title.
  • Type: java.lang.String
  • Since: 1.1.3
  • Required: No

<windowPosition>

The position of the installer window when it opens. Coordinates are expressed as X Y (e.g. 50 50).
  • Type: java.lang.String
  • Since: 1.1.3
  • Required: No
  • Default: 50 50

<windowSize>

The size of the installer window. Coordinates are expressed as X Y (e.g. 480 300)
  • Type: java.lang.String
  • Since: 1.1.3
  • Required: No
  • Default: 480 300