zephyr:generate-sfx

Full name:

io.zephyr.maven:zephyr-maven-plugin:2.0.55.Final:generate-sfx

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: process-resources.

Required Parameters

Name Type Since Description
<platform> String - (no description)
User property is: generate-sfx.platform.
Alias is: platform.
<workspace> File - this property specifies which directory we're placing the resulting executable archive into
Default value is: ${project.build.directory}/sfx-workspace.
User property is: generate-sfx.workspace.
Alias is: workspace.

Optional Parameters

Name Type Since Description
<archive-base> File - since the actual file-name is platform-dependent, this property constitutes the base path of the archive (such as the "target/aire" component of the path "target/aire.exe")
User property is: generate-sfx.archive-base.
Alias is: archive-base.
<archive-directory> File - the archive-directory property specifies which directory we're archiving and making executable
Default value is: ${project.basedir}/archive.
User property is: generate-sfx.archive-directory.
Alias is: archive-directory.
<executable-configuration> ExecutableConfiguration - (no description)
User property is: generate-sfx.executable-configuration.
Alias is: executable-configuration.
<executableFile> String - Every executable generated must perform some steps upon execution. For instance, it's typical to launch an installer such as IZPack. This file should contain instructions for doing so
User property is: generate-sfx.executable-file.
Alias is: executable-file.

Parameter Details

<archive-base>

since the actual file-name is platform-dependent, this property constitutes the base path of the archive (such as the "target/aire" component of the path "target/aire.exe")
  • Type: java.io.File
  • Required: No
  • User Property: generate-sfx.archive-base
  • Alias: archive-base

<archive-directory>

the archive-directory property specifies which directory we're archiving and making executable
  • Type: java.io.File
  • Required: No
  • User Property: generate-sfx.archive-directory
  • Default: ${project.basedir}/archive
  • Alias: archive-directory

<executable-configuration>

(no description)
  • Type: io.zephyr.maven.ExecutableConfiguration
  • Required: No
  • User Property: generate-sfx.executable-configuration
  • Alias: executable-configuration

<executableFile>

Every executable generated must perform some steps upon execution. For instance, it's typical to launch an installer such as IZPack. This file should contain instructions for doing so
  • Type: java.lang.String
  • Required: No
  • User Property: generate-sfx.executable-file
  • Alias: executable-file

<platform>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: generate-sfx.platform
  • Alias: platform

<workspace>

this property specifies which directory we're placing the resulting executable archive into
  • Type: java.io.File
  • Required: Yes
  • User Property: generate-sfx.workspace
  • Default: ${project.build.directory}/sfx-workspace
  • Alias: workspace