Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
njord:compare Compares two given stores against each other.
njord:drop Drops given store.
njord:drop-all Tabula rasa: drops all stores. For safety reasons, you need extra -Dyes.
njord:export Export out a store as "transportable bundle" to given path.
njord:export-all Export out all stores as "transportable bundle" to given path.
njord:help Display help information on njord.
Call mvn njord:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
njord:import Imports a store from "transportable bundle".
njord:import-all Imports all stores from "transportable bundle" files found in given directory.
njord:list List all existing stores.
njord:list-comparators Lists available comparators.
njord:list-content Lists content of given store.
njord:list-publishers Lists available publishers.
njord:list-templates List all existing templates.
njord:merge Merges from store onto to store, eventually dropping from store.
njord:merge-all Merges all stores onto one store, dropping all merged stores.

This is a special Mojo meant to be used in automation mostly. It assumes that Njord contains two or more stores (probably imported) and all of them were created using same template. This mojo will gather all those stores and merge them into one, resetting store name, so user will end up with one (merged) store named as

prefix-00001
. In any other case, this mojo will fail and report error.
njord:publish Publishes given store to given target.
njord:redeploy Redeploys from store onto to store, eventually dropping from store.
njord:status Shows publishing status and configuration for given project.
njord:validate Validate given store against given publisher.
njord:write Writes out a store as "remote Maven repository" directory structure to given directory.
njord:write-bundle Write out a store as "bundle" ZIP to given path. The ZIP file has remote repository layout and contains all the artifacts and metadata.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven [3.9,)
JDK [8,)

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 0.6.0 to 0.7.0 - 8
from 0.4.0 to 0.5.5 - 11
from 0.1.1 to 0.3.3 - 17
0.1.0 - -

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>eu.maveniverse.maven.plugins</groupId>
          <artifactId>njord</artifactId>
          <version>0.7.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>eu.maveniverse.maven.plugins</groupId>
        <artifactId>njord</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"