Cookbook: How to attach source and javadoc artifacts?

Summary

This recipe describes how to attach source and javadoc artifacts to your build.

Prerequisite Plugins

Here is the list of the plugins used:

Plugin Version
source 2.0.4
javadoc 2.3

Sample Generated Output

  1. attach-source-javadoc
  2. |-- pom.xml
  3. |-- src\
  4. `-- target
  5.     `-- attach-source-javadoc-1.0-SNAPSHOT.jar
  6.     `-- attach-source-javadoc-1.0-SNAPSHOT-javadoc.jar
  7.     `-- attach-source-javadoc-1.0-SNAPSHOT-sources.jar

Recipe

Configuring Maven Source Plugin

We execute the source:jar goal from the source plugin during the package phase.

  1. <plugin>
  2.   <groupId>org.apache.maven.plugins</groupId>
  3.   <artifactId>maven-source-plugin</artifactId>
  4.   <executions>
  5.     <execution>
  6.       <id>attach-sources</id>
  7.       <goals>
  8.         <goal>jar</goal>
  9.       </goals>
  10.     </execution>
  11.   </executions>
  12. </plugin>

Configuring Maven Javadoc Plugin

Same thing for the javadoc:jar goal from the javadoc plugin.

  1. <plugin>
  2.   <groupId>org.apache.maven.plugins</groupId>
  3.   <artifactId>maven-javadoc-plugin</artifactId>
  4.   <executions>
  5.     <execution>
  6.       <id>attach-javadocs</id>
  7.       <goals>
  8.         <goal>jar</goal>
  9.       </goals>
  10.     </execution>
  11.   </executions>
  12. </plugin>

Running Maven

Just call Maven to generate the packages:

  1. mvn package

Other Tips

To improve the build time or for a release, you could also define these plugins in a profile.

Resources