Plugin Documentation

Goals available for this plugin:

Goal Description
wix:attach-bundle Attach the (signed) bundle engine back to the bundle. TODO: might be more appropriate to use custom phase. insignia -ab engine.exe bundle.exe -o bundle.exe ... sign bundle.exe
wix:candle Goal which executes WiX candle to create a .wixobj file. The following project dependency inclusion patterns apply
Dependent NAR project 'Foo' with possible nar output redefined as 'bar'
  • -dFoo.TargetDir=Foo-version\
  • -dFoo.TargetExt=.wixlib
  • -dFoo.TargetFileName=bar.type
  • -dFoo.TargetName=bar
wix:detach-bundle Detach the bundle engine from the bundle for signing. TODO: might be more appropriate to use custom phase. insignia -ib bundle.exe -o engine.exe ... sign engine.exe
wix:harvest Generates WiX authoring from various input formats. Every time heat is run it regenerates the output file and any changes are lost.
wix:inscribe Using insignia tool to inscribe each msi with signature details of external cabs ie. insignia -im setup.msi TODO: support writing the inscribed msi to a different location/name
wix:light Goal which executes WiX light to create a .msi file. The following project dependency inclusion patterns apply
Dependent Wixlib project 'Foo' with possible output redefined as 'bar' adds to commandline
${narunpack}\Foo-version\Bar.wixlib
wix:lit Goal which executes WiX lit to create a .wixlib file.
wix:package Jars up the files associated with the msi/installbundle such as cabs.
wix:patch Goal which executes WiX torch & pyro to create msp files.
wix:prepare-package Create meta about this build for dependency inclusion.
wix:smoke Smoke to perform 'unit' testing of msi/msp Smoke runs ICE similar to light, this goal allows a seperate execution from the linker step. Optionally translate into unit test report output
wix:toolset Goal to initialize the workspace with wix toolset.
wix:transform Goal which executes WiX torch to create diff files - mst, cab
wix:unpack-dependencies Goal that unpacks the project dependencies from the repository to a defined location.
wix:validate Goal to validate the configuration
wix:wixproj Goal which executes WiX candle to create a .wixobj file. The following project dependency inclusion patterns apply
Dependent NAR project 'Foo' with possible nar output redefined as 'bar'
  • -dFoo.TargetDir=Foo-version\
  • -dFoo.TargetExt=.wixlib
  • -dFoo.TargetFileName=bar.type
  • -dFoo.TargetName=bar

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.2.1
JDK 1.6
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>com.github.wix-maven</groupId>
          <artifactId>wix-maven-plugin</artifactId>
          <version>0.3.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.github.wix-maven</groupId>
        <artifactId>wix-maven-plugin</artifactId>
        <version>0.3.0</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"