commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chtom...@apache.org
Subject [05/29] commons-release-plugin git commit: (docs) updates to documentation
Date Mon, 05 Mar 2018 17:37:11 GMT
(docs) updates to documentation


Project: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/commit/e227fdd2
Tree: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/tree/e227fdd2
Diff: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/diff/e227fdd2

Branch: refs/heads/master
Commit: e227fdd20e664b6a7795db258d2c20d69c204a42
Parents: 6ed02a8
Author: Rob Tompkins <chtompki@gmail.com>
Authored: Thu Feb 15 08:51:29 2018 -0500
Committer: Rob Tompkins <chtompki@gmail.com>
Committed: Thu Feb 15 08:51:29 2018 -0500

----------------------------------------------------------------------
 src/site/xdoc/development.xml | 7 +++++--
 src/site/xdoc/index.xml       | 5 ++---
 2 files changed, 7 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/e227fdd2/src/site/xdoc/development.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/development.xml b/src/site/xdoc/development.xml
index 8404c11..441dd5c 100644
--- a/src/site/xdoc/development.xml
+++ b/src/site/xdoc/development.xml
@@ -57,7 +57,7 @@ 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
@@ -65,11 +65,14 @@ private Boolean dryRun;
 <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>

http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/e227fdd2/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 39bb932..db319e7 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -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>
 


Mime
View raw message