Plugin Documentation

Goals available for this plugin:

GoalDescription
nbm:autoupdateCreate the Netbeans autopdate site definition.
nbm:brandingPackage branding resources for NetBeans platform/IDE based application. The format of branding resources is the same as in NetBeans Ant-based projects. The src/main/nbm-branding folder of the project is assumed to contain the branding content. Within the directory, the following folder structure is assumed:
  • 1. pick the IDE/platform module which contents you want to brand. eg. org-openide-windows.jar
  • 2. locate the jar within the IDE/platform installation and it's cluster, eg. modules/org-openide-windows.jar
  • 3. create the same folder structure in src/main/nbm-branding, make folder with the module's jar name as well. eg. create folder by name modules/org-openide-windows.jar
  • 4. within that folder place your branding modifications at the same location, as if they were withn the jar, eg. org/openide/windows/ui/Bundle.properties and place the changed bundle keys there.
nbm:clusterCreate the Netbeans module clusters from reactor
nbm:cluster-appCreate the Netbeans module clusters/application for the 'nbm-application' packaging projects
nbm:helpDisplay help information on nbm-maven-plugin.
Call 
  mvn nbm:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
nbm:manifestGoal for generating NetBeans module system specific manifest entries, part of "nbm" lifecycle/packaging. In order to have the generated manifest picked up by the maven-jar-plugin, one shall add the following configuration snippet to maven-jar-plugin.

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.2</version>
<configuration>
<useDefaultManifestFile>true</useDefaultManifestFile>
</configuration>
</plugin>

nbm:nbmCreate the Netbeans module artifact (nbm file), part of "nbm" lifecycle/packaging.

nbm:populate-repositoryA goal for identifying netbeans modules from the installation and populating the local repository with them. Optionally you can also deploy to a remote repository.

If you are looking for an existing remote repository for netbeans artifacts, check out http://bits.netbeans.org/maven2/, it contains API artifacts for multiple releases.

See this HOWTO on how to generate the NetBeans binaries required by this goal.

Compatibility Note: The 3.0+ version puts all unrecognized, non-module, 3rd party jars in the org.netbeans.external group and adds them as dependencies to respective modules. That can cause backward incompatibility with earlier versions which generated incomplete (different) maven metadata.

nbm:run-ideRun NetBeans IDE with additional custom module clusters, to be used in conjunction with nbm:cluster.
nbm:run-platformRun a branded application on top of NetBeans Platform. To be used with projects with nbm-application packaging only and the project needs to be built first.
nbm:standalone-zipCreate a standalone application out of the composed clusters of nbm-application
nbm:webstart-appCreate webstartable binaries for a 'nbm-application'.

System Requirements

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

Maven2.0.6
JDK1.6
MemoryNo minimum requirement.
Disk SpaceNo 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>org.codehaus.mojo</groupId>
          <artifactId>nbm-maven-plugin</artifactId>
          <version>3.6</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>nbm-maven-plugin</artifactId>
        <version>3.6</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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