Skip to content

Latest commit

 

History

History
138 lines (95 loc) · 6.47 KB

README.md

File metadata and controls

138 lines (95 loc) · 6.47 KB
Raw

Nexus Repository CPAN Format

Maven Central CircleCI Join the chat at https://gitter.im/sonatype/nexus-developers DepShield Badge

Table Of Contents

Developing

Requirements

Also, there is a good amount of information available at Bundle Development

Building

To build the project and generate the bundle use Maven

mvn clean install

If everything checks out, the bundle for CPAN should be available in the target folder

Using CPAN With Nexus Repository Manager 3

Requires Nexus Repository Manager version >= 3.8.0

We have detailed instructions on how to get started here!

Installing the plugin

There are a range of options for installing the CPAN plugin. You'll need to build it first, and then install the plugin with the options shown below:

Temporary Install

Installations done via the Karaf console will be wiped out with every restart of Nexus Repository. This is a good installation path if you are just testing or doing development on the plugin.

  • Enable the NXRM console: edit <nexus_dir>/bin/nexus.vmoptions and change karaf.startLocalConsole to true.

    More details here: Bundle Development

  • Run NXRM's console:

    # sudo su - nexus
$ cd <nexus_dir>/bin
$ ./nexus run
> bundle:install file:///tmp/nexus-repository-cpan-1.0.0.jar
> bundle:list

    (look for org.sonatype.nexus.plugins:nexus-repository-cpan ID, should be the last one)

    > bundle:start <org.sonatype.nexus.plugins:nexus-repository-cpan ID>

(more) Permanent Install

For more permanent installs of the nexus-repository-cpan plugin, follow these instructions:

  • Copy the bundle (nexus-repository-cpan-1.0.0.jar) into <nexus_dir>/deploy

This will cause the plugin to be loaded with each restart of Nexus Repository. As well, this folder is monitored by Nexus Repository and the plugin should load within 60 seconds of being copied there if Nexus Repository is running. You will still need to start the bundle using the karaf commands mentioned in the temporary install.

(most) Permanent Install

If you are trying to use the CPAN plugin permanently, it likely makes more sense to do the following:

  • Copy the bundle into <nexus_dir>/system/org/sonatype/nexus/plugins/nexus-repository-cpan/1.0.0/nexus-repository-cpan-1.0.0.jar

  • Make the following additions marked with + to <nexus_dir>/system/org/sonatype/nexus/assemblies/nexus-core-feature/3.x.y/nexus-core-feature-3.x.y-features.xml

          <feature prerequisite="false" dependency="false">wrap</feature>
+     <feature prerequisite="false" dependency="false">nexus-repository-cpan</feature>

    to the <feature name="nexus-core-feature" description="org.sonatype.nexus.assemblies:nexus-core-feature" version="3.x.y.xy"> section below the last (above is an example, the exact last one may vary).

    And

    + <feature name="nexus-repository-cpan" description="org.sonatype.nexus.plugins:nexus-repository-cpan" version="1.0.0">
+     <details>org.sonatype.nexus.plugins:nexus-repository-cpan</details>
+     <bundle>mvn:org.sonatype.nexus.plugins/nexus-repository-cpan/1.0.0</bundle>
+ </feature>
 </features>

    as the last feature.

This will cause the plugin to be loaded and started with each startup of Nexus Repository.

The Fine Print

It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)

Remember:

  • Use this contribution at the risk tolerance that you have
  • Do NOT file Sonatype support tickets related to CPAN support in regard to this plugin
  • DO file issues here on GitHub, so that the community can pitch in

Phew, that was easier than I thought. Last but not least of all:

Have fun creating and using this plugin and the Nexus platform, we are glad to have you here!

Getting help

Looking to contribute to our code but need some help? There's a few ways to get information: