Overview
HOWTOs

nb-repository:populate

Full name:

org.apache.netbeans.utilities:nb-repository-plugin:1.8-SNAPSHOT:populate

Description:

A 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 Maven Central. http://bits.netbeans.org/nexus/content/groups/netbeans/, contains contains API artifacts for older NetBeans releases. https://repository.apache.org/content/groups/snapshots may also be used for dev-SNAPSHOT artifacts if you wish to test development builds.

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

Attributes:

  • Executes as an aggregator plugin.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<netbeansInstallDirectory> File - Location of NetBeans installation
User property is: netbeansInstallDirectory.
<netbeansNbmDirectory> File 3.0 If defined, will match the nbm files found in the designated folder with the modules and upload the nbm file next to the module jar in local and remote repositories. Assumes a folder with <code-name-base>.nbm files containing nbm files for modules.
User property is: netbeansNbmDirectory.

Optional Parameters

Name Type Since Description
<defineCluster> boolean 3.7 Whether to create cluster POMs in the org.netbeans.cluster group. Only meaningful when forcedVersion is defined.
Default value is: true.
User property is: defineCluster.
<dependencyRepositoryId> String 3.7 Repository ID to use when inspecting remote dependencies. Only meaningful when dependencyRepositoryUrl is defined.
Default value is: temp.
User property is: dependencyRepositoryId.
<dependencyRepositoryUrl> String 3.7 Optional remote repository to use for inspecting remote dependencies. This may be used to populate just part of an installation, when base modules are already available in Maven format. Currently only supported when forcedVersion is defined.
User property is: dependencyRepositoryUrl.
<deployId> String - an string id representing the server
Default value is: netbeans.
User property is: deployId.
<deployUrl> String - an url where to deploy the NetBeans artifacts. Optional, if not specified, the artifacts will be only installed in local repository, if you need to give credentials to access remote repo, the id of the server is hardwired to "netbeans".
User property is: deployUrl.
<externallist> File 1.16 When specified it points to a file containing a merge of all binaries-list sha1;coordinate;module Any dependencies not found this way, will be generated with a unique id under the org.netbeans.external groupId.
User property is: externallist.
<forcedVersion> String - When specified, will force all modules to have the designated version. Good when depending on releases. Then you would for example specify RELEASE50 in this parameter and all modules get this version in the repository. If not defined, the maven version is derived from the OpenIDE-Module-Specification-Version manifest attribute.

Highly Recommended!


User property is: forcedVersion.
<groupIdPrefix> String 1.2 a prefix for groupId of generated content, eg. for org.netbeans value will generate org.netbeans.cluster groupId for clusters and org.netbeans.modules for module artifacts.
Default value is: org.netbeans.
User property is: groupIdPrefix.
<netbeansJavadocDirectory> File - If you want to install/deploy also NetBeans api javadocs, download the javadoc zip file from netbeans.org expand it to a directory, it should contain multiple zip files. Define this parameter as absolute path to the zip files folder.
User property is: netbeansJavadocDirectory.
<netbeansSourcesDirectory> File - Assumes a folder with <code-name-base>.zip files containing sources for modules.
User property is: netbeansSourcesDirectory.
<parentGAV> String 1.4 Colon separated artefact coordinate groupId:artefactId:version that represent parent to be used
User property is: parentGAV.
<skipLocalInstall> boolean 3.0 By default the generated metadata is installed in local repository. Setting this parameter to false will avoid installing the bits. Only meaningful together with a defined "deployUrl" parameter.
Default value is: false.
User property is: skipInstall.

Parameter Details

<defineCluster>

Whether to create cluster POMs in the org.netbeans.cluster group. Only meaningful when forcedVersion is defined.
  • Type: boolean
  • Since: 3.7
  • Required: No
  • User Property: defineCluster
  • Default: true

<dependencyRepositoryId>

Repository ID to use when inspecting remote dependencies. Only meaningful when dependencyRepositoryUrl is defined.
  • Type: java.lang.String
  • Since: 3.7
  • Required: No
  • User Property: dependencyRepositoryId
  • Default: temp

<dependencyRepositoryUrl>

Optional remote repository to use for inspecting remote dependencies. This may be used to populate just part of an installation, when base modules are already available in Maven format. Currently only supported when forcedVersion is defined.
  • Type: java.lang.String
  • Since: 3.7
  • Required: No
  • User Property: dependencyRepositoryUrl

<deployId>

an string id representing the server
  • Type: java.lang.String
  • Required: No
  • User Property: deployId
  • Default: netbeans

<deployUrl>

an url where to deploy the NetBeans artifacts. Optional, if not specified, the artifacts will be only installed in local repository, if you need to give credentials to access remote repo, the id of the server is hardwired to "netbeans".
  • Type: java.lang.String
  • Required: No
  • User Property: deployUrl

<externallist>

When specified it points to a file containing a merge of all binaries-list sha1;coordinate;module Any dependencies not found this way, will be generated with a unique id under the org.netbeans.external groupId.
  • Type: java.io.File
  • Since: 1.16
  • Required: No
  • User Property: externallist

<forcedVersion>

When specified, will force all modules to have the designated version. Good when depending on releases. Then you would for example specify RELEASE50 in this parameter and all modules get this version in the repository. If not defined, the maven version is derived from the OpenIDE-Module-Specification-Version manifest attribute.

Highly Recommended!

  • Type: java.lang.String
  • Required: No
  • User Property: forcedVersion

<groupIdPrefix>

a prefix for groupId of generated content, eg. for org.netbeans value will generate org.netbeans.cluster groupId for clusters and org.netbeans.modules for module artifacts.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: groupIdPrefix
  • Default: org.netbeans

<netbeansInstallDirectory>

Location of NetBeans installation
  • Type: java.io.File
  • Required: Yes
  • User Property: netbeansInstallDirectory

<netbeansJavadocDirectory>

If you want to install/deploy also NetBeans api javadocs, download the javadoc zip file from netbeans.org expand it to a directory, it should contain multiple zip files. Define this parameter as absolute path to the zip files folder.
  • Type: java.io.File
  • Required: No
  • User Property: netbeansJavadocDirectory

<netbeansNbmDirectory>

If defined, will match the nbm files found in the designated folder with the modules and upload the nbm file next to the module jar in local and remote repositories. Assumes a folder with <code-name-base>.nbm files containing nbm files for modules.
  • Type: java.io.File
  • Since: 3.0
  • Required: Yes
  • User Property: netbeansNbmDirectory

<netbeansSourcesDirectory>

Assumes a folder with <code-name-base>.zip files containing sources for modules.
  • Type: java.io.File
  • Required: No
  • User Property: netbeansSourcesDirectory

<parentGAV>

Colon separated artefact coordinate groupId:artefactId:version that represent parent to be used
  • Type: java.lang.String
  • Since: 1.4
  • Required: No
  • User Property: parentGAV

<skipLocalInstall>

By default the generated metadata is installed in local repository. Setting this parameter to false will avoid installing the bits. Only meaningful together with a defined "deployUrl" parameter.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: skipInstall
  • Default: false