Nexus Repository R Format

Table Of Contents

• Developing
  • Requirements
  • Building
• Using R with Nexus Repository Manager 3
• Installing the plugin
  • Temporary Install
  • (more) Permanent Install
  • (most) Permament Install
• The Fine Print
• Getting Help

Developing

Contribution Guidelines

Go read our contribution guidelines to get a bit more familiar with how we would like things to flow.

Requirements

• Apache Maven 3.3.3+
• OpenJDK 8
• Network access to https://repository.sonatype.org/content/groups/sonatype-public-grid

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 R should be available in the target folder

Using R With Nexus Repository Manager 3

After installing the plugin, we have detailed instructions on how to get started here!

Compatibility with Nexus Repository Manager 3 Versions

The table below outlines what version of Nexus Repository the plugin was built against

Plugin Version	Nexus Repository Version
v1.0.0	<3.8.0-02
v1.0.1	>=3.8.0-02
v1.0.2	>=3.14.0-04
v1.0.3	>=3.15.2-01
v1.0.4	>=3.18.0-01

If a new version of Nexus Repository is released and the plugin needs changes, a new release will be made, and this table will be updated to indicate which version of Nexus Repository it will function against. This is done on a time available basis, as this is community supported. If you see a new version of Nexus Repository, go ahead and update the plugin and send us a PR after testing it out!

All released versions can be found here.

Installing the plugin

There are a range of options for installing the R 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 Nexus console: edit <nexus_dir>/bin/nexus.vmoptions and change karaf.startLocalConsole to true.

  More details here: https://help.sonatype.com/display/NXRM3/Installing+Bundles

• Run NXRM console mode (the below assumes you are running as 'nexus' user as recommended in our documentation) and enter the bundle command after it has started:

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

  This will return text similar to "Bundle ID: 282". You can double check this ID using bundle:list (for org.sonatype.nexus.plugins:nexus-repository-r; it should be the last one). Then start it using this bundle command:

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

(more) Permanent Install

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

• Copy the bundle (nexus-repository-r-1.0.3.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 R plugin permanently, it likely makes more sense to do the following:

• Copy the bundle into <nexus_dir>/system/org/sonatype/nexus/plugins/nexus-repository-r/1.0.3/nexus-repository-r-1.0.3.jar
• If you are using OSS edition, make these mods in: <nexus_dir>/system/com/sonatype/nexus/assemblies/nexus-oss-feature/3.x.y/nexus-oss-feature-3.x.y-features.xml
• If you are using PRO edition, make these mods in: <nexus_dir>/system/com/sonatype/nexus/assemblies/nexus-pro-feature/3.x.y/nexus-pro-feature-3.x.y-features.xml

        <feature version="3.x.y.xy" prerequisite="false" dependency="false">nexus-repository-rubygems</feature>
  +     <feature version="1.0.3" prerequisite="false" dependency="false">nexus-repository-r</feature>
        <feature version="3.x.y.xy" prerequisite="false" dependency="false">nexus-repository-yum</feature>
    </feature>
  

  And

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

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 R support
• 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:

• Chat with us on Gitter
• Check out the Nexus3 tag on Stack Overflow
• Check out the Nexus Repository User List