Usage

There are a couple things you need to do to use Maven Shared Resources. First you need to give the plugin that will use the resources access to them. After that you configure the plugin to actually use the resources.

Add the resources to the plugin

First you add maven-shared-resources as a dependency to a plugin in your pom.xml. This is done to give the plugin access to the resources within the maven-shared-resources JAR file. In this example we will use the resources in Maven Changes Plugin.

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.4</version>
        <configuration>
          ...
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.apache.maven.shared</groupId>
            <artifactId>maven-shared-resources</artifactId>
            <version>1</version>
          </dependency>
        </dependencies>
        <executions>
          ...
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

Configure the plugin to use the resources

Now you can use the resources in the plugin. You can use them as if they existed in your own project, like this:

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.4</version>
        <configuration>
          <templateDirectory>org/apache/maven/plugins</templateDirectory>
        </configuration>
        <dependencies>
          ...
        </dependencies>
        <executions>
          ...
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

Execute the plugin

All is now set up to make use of the resources in the plugin for your project. Execute the plugin like you would normally do, to see the resources put to practical use.

mvn changes:announcement-generate