nbm:populate-repository

Full name:

org.codehaus.mojo:nbm-maven-plugin:3.6:populate-repository

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 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.

Attributes:

  • Executes as an aggregator plugin.

Optional Parameters

Name Type Since Description
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".
forcedVersion String - Optional parameter, 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!
netbeansInstallDirectory File - Location of netbeans installation
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.
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.
netbeansSourcesDirectory File - Assumes a folder with <code-name-base>.zip files containing sources for modules.
nexusIndexDirectory File 3.0 Optional parameter, when specified it shall point to a directory containing a Nexus Lucene index. This index will be used to find external libraries that are referenced by NetBeans modules and populate the POM metadata with correct dependencies. Any dependencies not found this way, will be generated a unique id under the org.netbeans.external groupId.

The Nexus Lucene index zip file for central repository can be found here: http://repo1.maven.org/maven2/.index/nexus-maven-repository-index.zip Unzip it to a directory and use this parameter to point to it.
skipLocalInstall boolean 3.0 Optional parameter, 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.

Parameter Details

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
  • Expression: ${deployUrl}

forcedVersion:

Optional parameter, 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
  • Expression: ${forcedVersion}

netbeansInstallDirectory:

Location of netbeans installation
  • Type: java.io.File
  • Required: No
  • Expression: ${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
  • Expression: ${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: No
  • Expression: ${netbeansNbmDirectory}

netbeansSourcesDirectory:

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

nexusIndexDirectory:

Optional parameter, when specified it shall point to a directory containing a Nexus Lucene index. This index will be used to find external libraries that are referenced by NetBeans modules and populate the POM metadata with correct dependencies. Any dependencies not found this way, will be generated a unique id under the org.netbeans.external groupId.

The Nexus Lucene index zip file for central repository can be found here: http://repo1.maven.org/maven2/.index/nexus-maven-repository-index.zip Unzip it to a directory and use this parameter to point to it.
  • Type: java.io.File
  • Since: 3.0
  • Required: No
  • Expression: ${nexusIndexDirectory}

skipLocalInstall:

Optional parameter, 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
  • Expression: ${skipInstall}
  • Default: false