Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
Tue Jun 19 03:50:24 2018
@@ -3,8 +3,8 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<title>CommonsDistributionStagingMojo (Apache Commons Release Plugin
1.3-SNAPSHOT API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.3
API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css"
title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CommonsDistributionStagingMojo (Apache
Commons Release Plugin 1.3-SNAPSHOT API)";
+ parent.document.title="CommonsDistributionStagingMojo (Apache
Commons Release Plugin 1.3 API)";
}
}
catch(err) {
}
//-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
+var methods =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -97,7 +97,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
-<li><a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">java.lang.Object</a></li>
+<li><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.maven.plugin.AbstractMojo</li>
@@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab";
defaultPhase=DEPLOY,
threadSafe=true,
aggregator=true)
-public class <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.57">CommonsDistributionStagingMojo</a>
+public class <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.64">CommonsDistributionStagingMojo</a>
extends org.apache.maven.plugin.AbstractMojo</pre>
<div class="block">This class checks out the dev distribution location, copies
the distributions into that directory
structure under the <code>target/commons-release-plugin/scm</code> directory.
Then commits the
@@ -152,38 +152,62 @@ extends org.apache.maven.plugin.Abstract
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#basedir">basedir</a></span></code>
-<div class="block">The <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> that contains a
file to the root directory of the working project.</div>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir">baseDir</a></span></code>
+<div class="block">The <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> that contains a
file to the root directory of the working project.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsRcVersion">commonsRcVersion</a></span></code>
+<div class="block">The RC version of the release.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsReleaseVersion">commonsReleaseVersion</a></span></code>
+<div class="block">The release version of the artifact to be built.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distCheckoutDirectory">distCheckoutDirectory</a></span></code>
<div class="block">The location to which to checkout the dist subversion
repository under our working directory, which
was given above.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distSvnStagingUrl">distSvnStagingUrl</a></span></code>
<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distVersionRcVersionDirectory">distVersionRcVersionDirectory</a></span></code>
+<div class="block">A subdirectory of the dist directory into which we are
going to stage the release candidate.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#dryRun">dryRun</a></span></code>
<div class="block">A boolean that determines whether or not we actually commit
the files up to the subversion repository.</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private static <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#HEADER_FILE_NAME">HEADER_FILE_NAME</a></span></code>
+<div class="block">The name of file generated from the HEADER.vm velocity
template to be checked into the dist svn repo.</div>
+</td>
+</tr>
<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#isDistModule">isDistModule</a></span></code>
<div class="block">A parameter to generally avoid running unless it is
specifically turned on by the consuming module.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#password">password</a></span></code>
<div class="block">The password associated with <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>username</code></a>.</div>
</td>
@@ -196,19 +220,31 @@ extends org.apache.maven.plugin.Abstract
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colFirst"><code>private static <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#README_FILE_NAME">README_FILE_NAME</a></span></code>
+<div class="block">The name of file generated from the README.vm velocity
template to be checked into the dist svn repo.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#releaseNotesFile">releaseNotesFile</a></span></code>
-<div class="block">The location of the RELEASE-NOTES.txt file such that
multimodule builds can configure it.</div>
+<div class="block">The location of the RELEASE-NOTES.txt file such that
multi-module builds can configure it.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#siteDirectory">siteDirectory</a></span></code>
+<div class="block">The location to which the site gets built during running
<code>mvn site</code>.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username">username</a></span></code>
<div class="block">The username for the distribution subversion
repository.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory">workingDirectory</a></span></code>
<div class="block">The main working directory for the plugin, namely
<code>target/commons-release-plugin</code>, but
that assumes that we're using the default maven
<code>${project.build.directory}</code>.</div>
@@ -254,39 +290,56 @@ extends org.apache.maven.plugin.Abstract
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildDistBinariesRoot--">buildDistBinariesRoot</a></span>()</code>
-<div class="block">Build the path for the distribution binaries
directory.</div>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildReadmeAndHeaderHtmlFiles--">buildReadmeAndHeaderHtmlFiles</a></span>()</code>
+<div class="block">Builds up <code>README.html</code> and
<code>HEADER.html</code> that reside in following.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildDistSourceRoot--">buildDistSourceRoot</a></span>()</code>
-<div class="block">Build the path for the distribution source directory.</div>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyDistributionsIntoScmDirectoryStructureAndAddToSvn-java.io.File-org.apache.maven.scm.provider.ScmProvider-org.apache.maven.scm.repository.ScmRepository-">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> copiedReleaseNotes,
+
org.apache.maven.scm.provider.ScmProvider provider,
+
org.apache.maven.scm.repository.ScmRepository repository)</code>
+<div class="block">Copies the list of files at the root of the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>workingDirectory</code></a>
into
+ the directory structure of the distribution staging repository.</div>
</td>
</tr>
<tr id="i2" class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyDistributionsIntoScmDirectoryStructure-java.io.File-">copyDistributionsIntoScmDirectoryStructure</a></span>(<a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> copiedReleaseNotes)</code>
-<div class="block">Copies the list of files at the root of the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>workingDirectory</code></a>
into
- the directory structure of the distribution staging repository.</div>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyHeaderAndReadmeToSubdirectories-java.io.File-java.io.File-">copyHeaderAndReadmeToSubdirectories</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> headerFile,
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> readmeFile)</code>
+<div class="block">Copies <code>README.html</code> and
<code>HEADER.html</code> to the source and binaries
+ directories.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyReleaseNotesToWorkingDirectory--">copyReleaseNotesToWorkingDirectory</a></span>()</code>
<div class="block">A utility method that takes the
<code>RELEASE-NOTES.txt</code> file from the base directory of the
project and copies it into <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>workingDirectory</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
+<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copySiteToScmDirectory--">copySiteToScmDirectory</a></span>()</code>
+<div class="block">Copies <code>${basedir}/target/site</code> to
<code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#execute--">execute</a></span>()</code> </td>
</tr>
-<tr id="i5" class="rowColor">
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>private void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#listNotHiddenFilesAndDirectories-java.io.File-java.util.List-">listNotHiddenFilesAndDirectories</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> directory,
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> files)</code>
+<div class="block">Lists all directories and files to a flat list.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#setBasedir-java.io.File-">setBasedir</a></span>(<a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> basedir)</code>
-<div class="block">This method is the setter for the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#basedir"><code>basedir</code></a>
field, specifically
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#setBaseDir-java.io.File-">setBaseDir</a></span>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> baseDir)</code>
+<div class="block">This method is the setter for the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir"><code>baseDir</code></a>
field, specifically
for the usage in the unit tests.</div>
</td>
</tr>
@@ -302,8 +355,8 @@ extends org.apache.maven.plugin.Abstract
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
-<h3>Methods inherited from class java.lang.<a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></h3>
-<code><a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--";
title="class or interface in java.lang">clone</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-";
title="class or interface in java.lang">equals</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--";
title="class or interface in java.lang">finalize</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--";
title="class or interface in java.lang">getClass</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--";
title="class or interface in java.lang">hashCode</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--";
title="class or interface in java.lang">notify</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/ja
va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in
java.lang">notifyAll</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--";
title="class or interface in java.lang">toString</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--";
title="class or interface in java.lang">wait</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-";
title="class or interface in java.lang">wait</a>, <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-";
title="class or interface in java.lang">wait</a></code></li>
+<h3>Methods inherited from class java.lang.<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></h3>
+<code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--";
title="class or interface in java.lang">clone</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-";
title="class or interface in java.lang">equals</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--";
title="class or interface in java.lang">finalize</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--";
title="class or interface in java.lang">getClass</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--";
title="class or interface in java.lang">hashCode</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--";
title="class or interface in java.lang">notify</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/ja
va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in
java.lang">notifyAll</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--";
title="class or interface in java.lang">toString</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--";
title="class or interface in java.lang">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-";
title="class or interface in java.lang">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-";
title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -319,6 +372,34 @@ extends org.apache.maven.plugin.Abstract
<!-- -->
</a>
<h3>Field Detail</h3>
+<a name="README_FILE_NAME">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>README_FILE_NAME</h4>
+<pre>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.67">README_FILE_NAME</a></pre>
+<div class="block">The name of file generated from the README.vm velocity
template to be checked into the dist svn repo.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.README_FILE_NAME">Constant
Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HEADER_FILE_NAME">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HEADER_FILE_NAME</h4>
+<pre>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.69">HEADER_FILE_NAME</a></pre>
+<div class="block">The name of file generated from the HEADER.vm velocity
template to be checked into the dist svn repo.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.HEADER_FILE_NAME">Constant
Field Values</a></dd>
+</dl>
+</li>
+</ul>
<a name="project">
<!-- -->
</a>
@@ -327,23 +408,35 @@ extends org.apache.maven.plugin.Abstract
<h4>project</h4>
<pre>@Parameter(defaultValue="${project}",
required=true)
-private org.apache.maven.project.MavenProject <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.64">project</a></pre>
+private org.apache.maven.project.MavenProject <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.76">project</a></pre>
<div class="block">The <code>MavenProject</code> object is essentially the
context of the maven build at
a given time.</div>
</li>
</ul>
-<a name="basedir">
+<a name="baseDir">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>basedir</h4>
+<h4>baseDir</h4>
<pre>@Parameter(defaultValue="${basedir}")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.71">basedir</a></pre>
-<div class="block">The <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> that contains a
file to the root directory of the working project. Typically
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.83">baseDir</a></pre>
+<div class="block">The <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> that contains a
file to the root directory of the working project. Typically
this directory is where the <code>pom.xml</code> resides.</div>
</li>
</ul>
+<a name="siteDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>siteDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/site",
+ property="commons.siteOutputDirectory")
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.87">siteDirectory</a></pre>
+<div class="block">The location to which the site gets built during running
<code>mvn site</code>.</div>
+</li>
+</ul>
<a name="workingDirectory">
<!-- -->
</a>
@@ -352,7 +445,7 @@ private <a href="https://docs.oracl
<h4>workingDirectory</h4>
<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
property="commons.outputDirectory")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.78">workingDirectory</a></pre>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.94">workingDirectory</a></pre>
<div class="block">The main working directory for the plugin, namely
<code>target/commons-release-plugin</code>, but
that assumes that we're using the default maven
<code>${project.build.directory}</code>.</div>
</li>
@@ -365,7 +458,7 @@ private <a href="https://docs.oracl
<h4>distCheckoutDirectory</h4>
<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm",
property="commons.distCheckoutDirectory")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.86">distCheckoutDirectory</a></pre>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.102">distCheckoutDirectory</a></pre>
<div class="block">The location to which to checkout the dist subversion
repository under our working directory, which
was given above.</div>
</li>
@@ -378,8 +471,8 @@ private <a href="https://docs.oracl
<h4>releaseNotesFile</h4>
<pre>@Parameter(defaultValue="${basedir}/RELEASE-NOTES.txt",
property="commons.releaseNotesLocation")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.92">releaseNotesFile</a></pre>
-<div class="block">The location of the RELEASE-NOTES.txt file such that
multimodule builds can configure it.</div>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.108">releaseNotesFile</a></pre>
+<div class="block">The location of the RELEASE-NOTES.txt file such that
multi-module builds can configure it.</div>
</li>
</ul>
<a name="dryRun">
@@ -390,7 +483,7 @@ private <a href="https://docs.oracl
<h4>dryRun</h4>
<pre>@Parameter(property="commons.release.dryRun",
defaultValue="false")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.100">dryRun</a></pre>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.116">dryRun</a></pre>
<div class="block">A boolean that determines whether or not we actually commit
the files up to the subversion repository.
If this is set to <code>true</code>, we do all but make the commits. We do
checkout the repository in question
though.</div>
@@ -404,11 +497,10 @@ private <a href="https://docs.oracl
<h4>distSvnStagingUrl</h4>
<pre>@Parameter(defaultValue="",
property="commons.distSvnStagingUrl")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.109">distSvnStagingUrl</a></pre>
-<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged. Typicallly
- this would need to be of the form:
- <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>.
Note. that the prefix to the
- substring <code>https</code> is a requirement.</div>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.124">distSvnStagingUrl</a></pre>
+<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged. Typically this would need to
+ be of the form:
<code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>.
Note. that
+ the prefix to the substring <code>https</code> is a requirement.</div>
</li>
</ul>
<a name="isDistModule">
@@ -419,10 +511,32 @@ private <a href="https://docs.oracl
<h4>isDistModule</h4>
<pre>@Parameter(defaultValue="false",
property="commons.release.isDistModule")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.115">isDistModule</a></pre>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.130">isDistModule</a></pre>
<div class="block">A parameter to generally avoid running unless it is
specifically turned on by the consuming module.</div>
</li>
</ul>
+<a name="commonsReleaseVersion">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>commonsReleaseVersion</h4>
+<pre>@Parameter(property="commons.release.version")
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.136">commonsReleaseVersion</a></pre>
+<div class="block">The release version of the artifact to be built.</div>
+</li>
+</ul>
+<a name="commonsRcVersion">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>commonsRcVersion</h4>
+<pre>@Parameter(property="commons.rc.version")
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.142">commonsRcVersion</a></pre>
+<div class="block">The RC version of the release. For example the first voted
on candidate would be "RC1".</div>
+</li>
+</ul>
<a name="username">
<!-- -->
</a>
@@ -430,21 +544,33 @@ private <a href="https://docs.oracl
<li class="blockList">
<h4>username</h4>
<pre>@Parameter(property="user.name")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.121">username</a></pre>
-<div class="block">The username for the distribution subversion repository.
This is typically your apache id.</div>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.148">username</a></pre>
+<div class="block">The username for the distribution subversion repository.
This is typically your Apache id.</div>
</li>
</ul>
<a name="password">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>password</h4>
<pre>@Parameter(property="user.password")
-private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.127">password</a></pre>
+private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.154">password</a></pre>
<div class="block">The password associated with <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>username</code></a>.</div>
</li>
</ul>
+<a name="distVersionRcVersionDirectory">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>distVersionRcVersionDirectory</h4>
+<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.161">distVersionRcVersionDirectory</a></pre>
+<div class="block">A subdirectory of the dist directory into which we are
going to stage the release candidate. We
+ build this up in the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#execute--"><code>execute()</code></a>
method. And, for example,
+ the directory should look like
<code>https://https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</div>
+</li>
+</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
@@ -459,7 +585,7 @@ private <a href="https://docs.oracl
<ul class="blockListLast">
<li class="blockList">
<h4>CommonsDistributionStagingMojo</h4>
-<pre>public <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.57">CommonsDistributionStagingMojo</a>()</pre>
+<pre>public <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.64">CommonsDistributionStagingMojo</a>()</pre>
</li>
</ul>
</li>
@@ -476,7 +602,7 @@ private <a href="https://docs.oracl
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
-<pre>public void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.130">execute</a>()
+<pre>public void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.164">execute</a>()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<dl>
@@ -486,13 +612,29 @@ private <a href="https://docs.oracl
</dl>
</li>
</ul>
+<a name="listNotHiddenFilesAndDirectories-java.io.File-java.util.List-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>listNotHiddenFilesAndDirectories</h4>
+<pre>private void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.238">listNotHiddenFilesAndDirectories</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> directory,
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> files)</pre>
+<div class="block">Lists all directories and files to a flat list.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>directory</code> - <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> containing
directory to list</dd>
+<dd><code>files</code> - a <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"><code>List</code></a> of <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> to which to append
the files.</dd>
+</dl>
+</li>
+</ul>
<a name="copyReleaseNotesToWorkingDirectory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyReleaseNotesToWorkingDirectory</h4>
-<pre>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.205">copyReleaseNotesToWorkingDirectory</a>()
+<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.262">copyReleaseNotesToWorkingDirectory</a>()
throws
org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">A utility method that takes the
<code>RELEASE-NOTES.txt</code> file from the base directory of the
project and copies it into <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>workingDirectory</code></a>.</div>
@@ -500,92 +642,142 @@ private <a href="https://docs.oracl
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the RELEASE-NOTES.txt file that exists in the
<code>target/commons-release-notes/scm</code>
directory for the purpose of adding it to the scm change set in the
method
- <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyDistributionsIntoScmDirectoryStructure-java.io.File-"><code>copyDistributionsIntoScmDirectoryStructure(File)</code></a>.</dd>
+ <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyDistributionsIntoScmDirectoryStructureAndAddToSvn-java.io.File-org.apache.maven.scm.provider.ScmProvider-org.apache.maven.scm.repository.ScmRepository-"><code>copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,
+ ScmProvider, ScmRepository)</code></a>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io"><code>IOException</code></a> occurrs as
a wrapper so that maven
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io"><code>IOException</code></a> occurs as a
wrapper so that maven
can properly handle the exception.</dd>
</dl>
</li>
</ul>
-<a name="copyDistributionsIntoScmDirectoryStructure-java.io.File-">
+<a
name="copyDistributionsIntoScmDirectoryStructureAndAddToSvn-java.io.File-org.apache.maven.scm.provider.ScmProvider-org.apache.maven.scm.repository.ScmRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>copyDistributionsIntoScmDirectoryStructure</h4>
-<pre>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.241">copyDistributionsIntoScmDirectoryStructure</a>(<a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> copiedReleaseNotes)
- throws
org.apache.maven.plugin.MojoExecutionException</pre>
+<h4>copyDistributionsIntoScmDirectoryStructureAndAddToSvn</h4>
+<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.301">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> copiedReleaseNotes,
+
org.apache.maven.scm.provider.ScmProvider provider,
+
org.apache.maven.scm.repository.ScmRepository repository)
+ throws
org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Copies the list of files at the root of the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>workingDirectory</code></a>
into
the directory structure of the distribution staging repository. Specifically:
<ul>
- <li>root:</li>
- <li><ul>
+ <li>root:
+ <ul>
+ <li>site</li>
<li>site.zip</li>
<li>RELEASE-NOTES.txt</li>
- <li>source:</li>
- <li><ul>
+ <li>source:
+ <ul>
<li>-src artifacts....</li>
- </ul></li>
- <li>binaries:</li>
- <li><ul>
+ </ul>
+ </li>
+ <li>binaries:
+ <ul>
<li>-bin artifacts....</li>
- </ul></li>
- </ul></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>copiedReleaseNotes</code> - is the RELEASE-NOTES.txt file that
exists in the
<code>target/commons-release-plugin/scm</code>
directory.</dd>
+<dd><code>provider</code> - is the <code>ScmProvider</code> that we will use
for adding the files we wish to commit.</dd>
+<dd><code>repository</code> - is the <code>ScmRepository</code> that we will
use for adding the files that we wish to commit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"><code>List</code></a> of <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a>'s in the directory
for the purpose of adding them to the maven
+<dd>a <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"><code>List</code></a> of <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a>'s in the directory
for the purpose of adding them to the maven
<code>ScmFileSet</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io"><code>IOException</code></a> occurrs so
that Maven can handle it properly.</dd>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io"><code>IOException</code></a> occurs so
that Maven can handle it properly.</dd>
</dl>
</li>
</ul>
-<a name="buildDistBinariesRoot--">
+<a name="copySiteToScmDirectory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>buildDistBinariesRoot</h4>
-<pre>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.278">buildDistBinariesRoot</a>()</pre>
-<div class="block">Build the path for the distribution binaries
directory.</div>
+<h4>copySiteToScmDirectory</h4>
+<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.342">copySiteToScmDirectory</a>()
+ throws
org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Copies <code>${basedir}/target/site</code> to
<code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the local absolute path into the checkedout subversion repository that is
where
- the binaries distributions are to be copied.</dd>
+<dd>the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"><code>List</code></a> of <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a>'s contained in
+ <code>${basedir}/target/commons-release-plugin/scm/site</code>, after
the copy is complete.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the site
copying fails for some reason.</dd>
</dl>
</li>
</ul>
-<a name="buildDistSourceRoot--">
+<a name="buildReadmeAndHeaderHtmlFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>buildDistSourceRoot</h4>
-<pre>private <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.290">buildDistSourceRoot</a>()</pre>
-<div class="block">Build the path for the distribution source directory.</div>
+<h4>buildReadmeAndHeaderHtmlFiles</h4>
+<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.376">buildReadmeAndHeaderHtmlFiles</a>()
+ throws
org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Builds up <code>README.html</code> and
<code>HEADER.html</code> that reside in following.
+ <ul>
+ <li>distRoot
+ <ul>
+ <li>binaries/HEADER.html (symlink)</li>
+ <li>binaries/README.html (symlink)</li>
+ <li>source/HEADER.html (symlink)</li>
+ <li>source/README.html (symlink)</li>
+ <li>HEADER.html</li>
+ <li>README.html</li>
+ </ul>
+ </li>
+ </ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the local absolute path into the checkedout subversion repository that is
where
- the source distributions are to be copied.</dd>
+<dd>the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"><code>List</code></a> of created files
above</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io"><code>IOException</code></a> occurs in
the creation of these
+ files fails.</dd>
+</dl>
+</li>
+</ul>
+<a name="copyHeaderAndReadmeToSubdirectories-java.io.File-java.io.File-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copyHeaderAndReadmeToSubdirectories</h4>
+<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.423">copyHeaderAndReadmeToSubdirectories</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> headerFile,
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> readmeFile)
+ throws
org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Copies <code>README.html</code> and
<code>HEADER.html</code> to the source and binaries
+ directories.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>headerFile</code> - The originally created <code>HEADER.html</code>
file.</dd>
+<dd><code>readmeFile</code> - The originally created <code>README.html</code>
file.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"><code>List</code></a> of created
files.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the <a
href="../../../../../../org/apache/commons/release/plugin/SharedFunctions.html#copyFile-org.apache.maven.plugin.logging.Log-java.io.File-java.io.File-"><code>SharedFunctions.copyFile(Log,
File, File)</code></a>
+ fails.</dd>
</dl>
</li>
</ul>
-<a name="setBasedir-java.io.File-">
+<a name="setBaseDir-java.io.File-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
-<h4>setBasedir</h4>
-<pre>protected void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.303">setBasedir</a>(<a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> basedir)</pre>
-<div class="block">This method is the setter for the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#basedir"><code>basedir</code></a>
field, specifically
+<h4>setBaseDir</h4>
+<pre>protected void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.450">setBaseDir</a>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io">File</a> baseDir)</pre>
+<div class="block">This method is the setter for the <a
href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir"><code>baseDir</code></a>
field, specifically
for the usage in the unit tests.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>basedir</code> - is the <a
href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> to be used as the
project's root directory when this mojo
+<dd><code>baseDir</code> - is the <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true";
title="class or interface in java.io"><code>File</code></a> to be used as the
project's root directory when this mojo
is invoked.</dd>
</dl>
</li>
