Overview
HOWTOs
Deprecated

nbm:autoupdate

Full name:

org.netbeans.maven:nbm-maven-plugin:4.2-SNAPSHOT:autoupdate

Description:

Create the NetBeans auto update site definition.

Attributes:

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

Required Parameters

Name Type Since Description
outputDirectory File - output directory.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
distBase String - A custom distribution base for the nbms in the update site. If NOT defined, the update site will use a simple relative URL, which is generally what you want. Defining it as "auto" will pick up the distribution URL from each NBM, which is generally wrong. See distributionUrl in nbm mojo for what url will be used in that case. The value is either a direct http protocol based URL that points to the location under which all nbm files are located, or allows to create an update site based on maven repository content. The resulting autoupdate site document can be uploaded as tar.gz to repository as well as attached artifact to the 'nbm-application' project.
Format: id::layout::url same as in maven-deploy-plugin
with the 'default' and 'legacy' layouts. (maven2 vs maven1 layout)
If the value doesn't contain :: characters, it's assumed to be the flat structure and the value is just the URL.
Default value is: ..
User property is: maven.nbm.customDistBase.
fileName String - autoupdate site xml file name.
Default value is: updates.xml.
User property is: maven.nbm.updatesitexml.
updateSiteIncludes List - List of Ant style patterns on artifact GA (groupID:artifactID) that should be included in the update site. Eg. org.netbeans.* matches all artifacts with any groupID starting with 'org.netbeans.', org.*:api will match any artifact with artifactId of 'api' and groupId starting with 'org.'

Parameter Details

distBase:

A custom distribution base for the nbms in the update site. If NOT defined, the update site will use a simple relative URL, which is generally what you want. Defining it as "auto" will pick up the distribution URL from each NBM, which is generally wrong. See distributionUrl in nbm mojo for what url will be used in that case. The value is either a direct http protocol based URL that points to the location under which all nbm files are located, or allows to create an update site based on maven repository content. The resulting autoupdate site document can be uploaded as tar.gz to repository as well as attached artifact to the 'nbm-application' project.
Format: id::layout::url same as in maven-deploy-plugin
with the 'default' and 'legacy' layouts. (maven2 vs maven1 layout)
If the value doesn't contain :: characters, it's assumed to be the flat structure and the value is just the URL.
  • Type: java.lang.String
  • Required: No
  • User Property: maven.nbm.customDistBase
  • Default: .

fileName:

autoupdate site xml file name.
  • Type: java.lang.String
  • Required: No
  • User Property: maven.nbm.updatesitexml
  • Default: updates.xml

outputDirectory:

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

updateSiteIncludes:

List of Ant style patterns on artifact GA (groupID:artifactID) that should be included in the update site. Eg. org.netbeans.* matches all artifacts with any groupID starting with 'org.netbeans.', org.*:api will match any artifact with artifactId of 'api' and groupId starting with 'org.'
  • Type: java.util.List
  • Required: No