[COMMONSSITE-97] Documentation for commons-release-plugin

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Implemented
• Component/s: Commons Release Plugin
• Assignee: Rob Tompkins
• Reporter: Rob Tompkins
• Created: 07/Jan/18 19:37
• Updated: 17/Jan/18 01:58
• Resolved: 11/Jan/18 01:20

Description

We need sufficient documentation on the usage of the commons-release-plugin in the site, and with javadoc. Note, the POC usage followed as:

<!-- Declaration place matters must be after gpg. -->
<plugin>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-release-plugin</artifactId>
  <version>0.1-SNAPSHOT</version>
  <configuration>
    <distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/text</distSvnStagingUrl>
    <username></username>
    <password></password>
  </configuration>
  <executions>
    <execution>
      <id>detatch-distributions</id>
      <phase>verify</phase>
      <goals>
        <goal>detatch-distributions</goal>
      </goals>
    </execution>
    <execution>
      <id>compress-site</id>
      <phase>site</phase>
      <goals>
        <goal>compress-site</goal>
      </goals>
    </execution>
    <execution>
      <id>stage-distributions</id>
      <phase>deploy</phase>
      <goals>
        <goal>stage-distributions</goal>
      </goals>
    </execution>
  </executions>
</plugin>