Skip to content
Permalink
Browse files
(docs) updates to documentation
  • Loading branch information
chtompki committed Feb 15, 2018
1 parent 6ed02a8 commit e227fdd20e664b6a7795db258d2c20d69c204a42
Showing 2 changed files with 7 additions and 5 deletions.
@@ -57,19 +57,22 @@ public class CommonsDistributionDetachmentMojo extends AbstractMojo {
imported to the Mojo by the existent maven variables or the declared <code>&lt;configuration&gt;</code>. For
example, we have a boolean variable named <code>dryRun</code> declared as:
<source><![CDATA[
@Parameter
@Parameter(property = "commons.release.dryRun", defaultValue = "false")
private Boolean dryRun;
]]></source>
that can be configured by
<source><![CDATA[
<plugin>
<groupId>org.apache.commons</groupId>
<artifactId>commons-release-plugin</artifactId>
<version>1.0</version>
<version>1.1</version>
<configuration>
<dryRun>true</dryRun>
</configuration>
</plugin>]]></source>

And, because we've set the <code>property here</code> (as in the 1.1 release), you can, on the command line,
use the following <code>-Dcommons.release.dryRun=true</code>.
</p>

</section>
@@ -82,7 +82,6 @@
<version>1.1</version>
<configuration>
<distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</distSvnStagingUrl>
<dryRun>${dryRun}</dryRun>
</configuration>
<executions>
<execution>
@@ -126,14 +125,14 @@
<li>
running the following command:
<source><![CDATA[
mvn -Duser.name=<yourApacheId> [-Duser.password=<yourApacheIdsPassword] [-DdryRun=true -Ptest-deploy] -Prelease clean test site deploy
mvn -Duser.name=<yourApacheId> [-Duser.password=<yourApacheIdsPassword] [-Dcommons.release.dryRun=true -Ptest-deploy] -Prelease clean test site deploy
]]></source>
</li>
</ol>
If the component is new, then, before running this maven command, you would want to create
the requisite subversion directory <code>https://dist.apache.org/repos/dist/dev/commons/foo</code>. Notice,
that the way to perform a dry run of the release you need to include
<code>-DdryRun=true -Ptest-deploy</code>.
<code>-Dcommons.release.dryRun=true -Ptest-deploy</code>.
</p>
</section>

0 comments on commit e227fdd

Please sign in to comment.