You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/06/25 19:04:10 UTC
svn commit: r62638 [8/39] - in /dev/commons/release-plugin/1.8.1-RC1: ./ binaries/ site/ site/apidocs/ site/apidocs/jquery/ site/apidocs/jquery/external/ site/apidocs/jquery/external/jquery/ site/apidocs/jquery/jszip-utils/ site/apidocs/jquery/jszip-ut...
Added: dev/commons/release-plugin/1.8.1-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.1-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added)
+++ dev/commons/release-plugin/1.8.1-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Sun Jun 25 19:04:09 2023
@@ -0,0 +1,1021 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.8.1 API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="../../../../../../jquery/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="../../../../../../jquery/jquery-ui.min.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.8.1 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+var pathtoroot = "../../../../../../";
+var useModuleDirectories = true;
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<header role="banner">
+<nav role="navigation">
+<div class="fixedNav">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../index.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CommonsDistributionStagingMojo.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses.html">All Classes</a></li>
+</ul>
+<ul class="navListSearch">
+<li><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a id="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+</div>
+<div class="navPadding"> </div>
+<script type="text/javascript"><!--
+$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
+//-->
+</script>
+</nav>
+</header>
+<!-- ======== START OF CLASS DATA ======== -->
+<main role="main">
+<div class="header">
+<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div>
+<h2 title="Class CommonsDistributionStagingMojo" class="title">Class CommonsDistributionStagingMojo</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<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" class="externalLink">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.maven.plugin.AbstractMojo</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd>
+</dl>
+<hr>
+<pre>@Mojo(name="stage-distributions",
+ defaultPhase=DEPLOY,
+ threadSafe=true,
+ aggregator=true)
+public class <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.67">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
+ distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.0</dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colSecond" scope="col">Field</th>
+<th class="colLast" scope="col">Description</th>
+</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" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#baseDir">baseDir</a></span></code></th>
+<td class="colLast">
+<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" class="externalLink"><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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commonsRcVersion">commonsRcVersion</a></span></code></th>
+<td class="colLast">
+<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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commonsReleaseVersion">commonsReleaseVersion</a></span></code></th>
+<td class="colLast">
+<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" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distCheckoutDirectory">distCheckoutDirectory</a></span></code></th>
+<td class="colLast">
+<div class="block">The location to which to check out 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/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distRcVersionDirectory">distRcVersionDirectory</a></span></code></th>
+<td class="colLast">
+<div class="block">A subdirectory of the dist directory into which we are going to stage the release candidate.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distServer">distServer</a></span></code></th>
+<td class="colLast">
+<div class="block">The ID of the server (specified in settings.xml) which should be used for dist authentication.</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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distSvnStagingUrl">distSvnStagingUrl</a></span></code></th>
+<td class="colLast">
+<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/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dryRun">dryRun</a></span></code></th>
+<td class="colLast">
+<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="altColor">
+<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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HEADER_FILE_NAME">HEADER_FILE_NAME</a></span></code></th>
+<td class="colLast">
+<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="rowColor">
+<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" class="externalLink">Boolean</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDistModule">isDistModule</a></span></code></th>
+<td class="colLast">
+<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#password">password</a></span></code></th>
+<td class="colLast">
+<div class="block">The password associated with <a href="#username"><code>username</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private org.apache.maven.project.MavenProject</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#project">project</a></span></code></th>
+<td class="colLast">
+<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at
+ a given time.</div>
+</td>
+</tr>
+<tr class="altColor">
+<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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#README_FILE_NAME">README_FILE_NAME</a></span></code></th>
+<td class="colLast">
+<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="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" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseNotesFile">releaseNotesFile</a></span></code></th>
+<td class="colLast">
+<div class="block">The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private org.apache.maven.settings.Settings</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settings">settings</a></span></code></th>
+<td class="colLast">
+<div class="block">Maven <code>Settings</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private org.apache.maven.settings.crypto.SettingsDecrypter</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settingsDecrypter">settingsDecrypter</a></span></code></th>
+<td class="colLast">
+<div class="block">Maven <code>SettingsDecrypter</code> component.</div>
+</td>
+</tr>
+<tr class="altColor">
+<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" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SIGNATURE_VALIDATOR_NAME">SIGNATURE_VALIDATOR_NAME</a></span></code></th>
+<td class="colLast">
+<div class="block">The name of the signature validation shell script to be checked into the dist svn repo.</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" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#siteDirectory">siteDirectory</a></span></code></th>
+<td class="colLast">
+<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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#username">username</a></span></code></th>
+<td class="colLast">
+<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/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#workingDirectory">workingDirectory</a></span></code></th>
+<td class="colLast">
+<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>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a id="fields.inherited.from.class.org.apache.maven.plugin.Mojo">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3>
+<code>ROLE</code></li>
+</ul>
+</li>
+</ul>
+</section>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Constructor</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tr class="altColor">
+<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CommonsDistributionStagingMojo</a></span>()</code></th>
+<td class="colLast"> </td>
+</tr>
+</table>
+</li>
+</ul>
+</section>
+<!-- ========== METHOD SUMMARY =========== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colSecond" scope="col">Method</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tr id="i0" 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" class="externalLink">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" class="externalLink">File</a>></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildReadmeAndHeaderHtmlFiles()">buildReadmeAndHeaderHtmlFiles</a></span>()</code></th>
+<td class="colLast">
+<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/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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" class="externalLink">File</a>></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">File</a> copiedReleaseNotes,
+ org.apache.maven.scm.provider.ScmProvider provider,
+ org.apache.maven.scm.repository.ScmRepository repository)</code></th>
+<td class="colLast">
+<div class="block">Copies the list of files at the root of the <a href="#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/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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" class="externalLink">File</a>></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">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" class="externalLink">File</a> readmeFile)</code></th>
+<td class="colLast">
+<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/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyReleaseNotesToWorkingDirectory()">copyReleaseNotesToWorkingDirectory</a></span>()</code></th>
+<td class="colLast">
+<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="#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/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copySignatureValidatorScriptToScmDirectory()">copySignatureValidatorScriptToScmDirectory</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Copies our <code>signature-validator.sh</code> script into
+ <code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<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" class="externalLink">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" class="externalLink">File</a>></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copySiteToScmDirectory()">copySiteToScmDirectory</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute()">execute</a></span>()</code></th>
+<td class="colLast"> </td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>private void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">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" class="externalLink">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" class="externalLink">File</a>> files)</code></th>
+<td class="colLast">
+<div class="block">Lists all directories and files to a flat list.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">File</a> baseDir)</code></th>
+<td class="colLast">
+<div class="block">This method is the setter for the <a href="#baseDir"><code>baseDir</code></a> field, specifically
+ for the usage in the unit tests.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a id="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3>
+<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</section>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a id="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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.74">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 id="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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.77">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 id="SIGNATURE_VALIDATOR_NAME">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SIGNATURE_VALIDATOR_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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.80">SIGNATURE_VALIDATOR_NAME</a></pre>
+<div class="block">The name of the signature validation shell script 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.SIGNATURE_VALIDATOR_NAME">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a id="project">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<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.85">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 id="baseDir">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>baseDir</h4>
+<pre>@Parameter(defaultValue="${basedir}")
+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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.92">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" class="externalLink"><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 id="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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.96">siteDirectory</a></pre>
+<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div>
+</li>
+</ul>
+<a id="workingDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>workingDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
+ property="commons.outputDirectory")
+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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.103">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>
+</ul>
+<a id="distCheckoutDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distCheckoutDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm",
+ property="commons.distCheckoutDirectory")
+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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.110">distCheckoutDirectory</a></pre>
+<div class="block">The location to which to check out the dist subversion repository under our working directory, which
+ was given above.</div>
+</li>
+</ul>
+<a id="releaseNotesFile">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>releaseNotesFile</h4>
+<pre>@Parameter(defaultValue="${basedir}/RELEASE-NOTES.txt",
+ property="commons.releaseNotesLocation")
+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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.117">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 id="dryRun">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>dryRun</h4>
+<pre>@Parameter(property="commons.release.dryRun",
+ defaultValue="false")
+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" class="externalLink">Boolean</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.125">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>
+</li>
+</ul>
+<a id="distSvnStagingUrl">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distSvnStagingUrl</h4>
+<pre>@Parameter(defaultValue="",
+ property="commons.distSvnStagingUrl")
+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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.133">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 id="isDistModule">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isDistModule</h4>
+<pre>@Parameter(defaultValue="false",
+ property="commons.release.isDistModule")
+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" class="externalLink">Boolean</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.139">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 id="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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.145">commonsReleaseVersion</a></pre>
+<div class="block">The release version of the artifact to be built.</div>
+</li>
+</ul>
+<a id="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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.151">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 id="distServer">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distServer</h4>
+<pre>@Parameter(property="commons.distServer")
+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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.158">distServer</a></pre>
+<div class="block">The ID of the server (specified in settings.xml) which should be used for dist authentication.
+ This will be used in preference to <a href="#username"><code>username</code></a>/<a href="#password"><code>password</code></a>.</div>
+</li>
+</ul>
+<a id="username">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>username</h4>
+<pre>@Parameter(property="user.name")
+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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.164">username</a></pre>
+<div class="block">The username for the distribution subversion repository. This is typically your Apache id.</div>
+</li>
+</ul>
+<a id="password">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>password</h4>
+<pre>@Parameter(property="user.password")
+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" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.170">password</a></pre>
+<div class="block">The password associated with <a href="#username"><code>username</code></a>.</div>
+</li>
+</ul>
+<a id="settings">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>settings</h4>
+<pre>@Parameter(defaultValue="${settings}",
+ readonly=true,
+ required=true)
+private org.apache.maven.settings.Settings <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.176">settings</a></pre>
+<div class="block">Maven <code>Settings</code>.</div>
+</li>
+</ul>
+<a id="settingsDecrypter">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>settingsDecrypter</h4>
+<pre>@Component
+private org.apache.maven.settings.crypto.SettingsDecrypter <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.182">settingsDecrypter</a></pre>
+<div class="block">Maven <code>SettingsDecrypter</code> component.</div>
+</li>
+</ul>
+<a id="distRcVersionDirectory">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>distRcVersionDirectory</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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.190">distRcVersionDirectory</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="#execute()"><code>execute()</code></a> method. And, for example,
+ the directory should look like <code>https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</div>
+</li>
+</ul>
+</li>
+</ul>
+</section>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a id="<init>()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CommonsDistributionStagingMojo</h4>
+<pre>public <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.71">CommonsDistributionStagingMojo</a>()</pre>
+</li>
+</ul>
+</li>
+</ul>
+</section>
+<!-- ============ METHOD DETAIL ========== -->
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a id="execute()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre class="methodSignature">public void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.192">execute</a>()
+ throws org.apache.maven.plugin.MojoExecutionException,
+ org.apache.maven.plugin.MojoFailureException</pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
+<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
+</dl>
+</li>
+</ul>
+<a id="listNotHiddenFilesAndDirectories(java.io.File,java.util.List)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>listNotHiddenFilesAndDirectories</h4>
+<pre class="methodSignature">private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.279">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink"><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" class="externalLink"><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" class="externalLink"><code>File</code></a> to which to append the files.</dd>
+</dl>
+</li>
+</ul>
+<a id="copyReleaseNotesToWorkingDirectory()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copyReleaseNotesToWorkingDirectory</h4>
+<pre class="methodSignature">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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.303">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="#workingDirectory"><code>workingDirectory</code></a>.</div>
+<dl>
+<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="#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/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>IOException</code></a> occurs as a wrapper so that maven
+ can properly handle the exception.</dd>
+</dl>
+</li>
+</ul>
+<a id="copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copyDistributionsIntoScmDirectoryStructureAndAddToSvn</h4>
+<pre class="methodSignature">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" class="externalLink">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" class="externalLink">File</a>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.342">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" class="externalLink">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="#workingDirectory"><code>workingDirectory</code></a> into
+ the directory structure of the distribution staging repository. Specifically:
+ <ul>
+ <li>root:
+ <ul>
+ <li>site</li>
+ <li>site.zip</li>
+ <li>RELEASE-NOTES.txt</li>
+ <li>source:
+ <ul>
+ <li>-src artifacts....</li>
+ </ul>
+ </li>
+ <li>binaries:
+ <ul>
+ <li>-bin artifacts....</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/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><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" class="externalLink"><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/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>IOException</code></a> occurs so that Maven can handle it properly.</dd>
+</dl>
+</li>
+</ul>
+<a id="copySignatureValidatorScriptToScmDirectory()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copySignatureValidatorScriptToScmDirectory</h4>
+<pre class="methodSignature">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" class="externalLink">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.384">copySignatureValidatorScriptToScmDirectory</a>()
+ throws org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Copies our <code>signature-validator.sh</code> script into
+ <code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>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" class="externalLink"><code>File</code></a> for the signature-validator.sh</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an error occurs while the resource is being copied</dd>
+</dl>
+</li>
+</ul>
+<a id="copySiteToScmDirectory()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copySiteToScmDirectory</h4>
+<pre class="methodSignature">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" class="externalLink">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" class="externalLink">File</a>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.403">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 <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><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" class="externalLink"><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 id="buildReadmeAndHeaderHtmlFiles()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>buildReadmeAndHeaderHtmlFiles</h4>
+<pre class="methodSignature">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" class="externalLink">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" class="externalLink">File</a>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.437">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 <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><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" class="externalLink"><code>IOException</code></a> occurs in the creation of these
+ files fails.</dd>
+</dl>
+</li>
+</ul>
+<a id="copyHeaderAndReadmeToSubdirectories(java.io.File,java.io.File)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copyHeaderAndReadmeToSubdirectories</h4>
+<pre class="methodSignature">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" class="externalLink">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" class="externalLink">File</a>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.489">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" class="externalLink">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" class="externalLink">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" class="externalLink"><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="../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 id="setBaseDir(java.io.File)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>setBaseDir</h4>
+<pre class="methodSignature">protected void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.516">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" class="externalLink">File</a> baseDir)</pre>
+<div class="block">This method is the setter for the <a href="#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/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>File</code></a> to be used as the project's root directory when this mojo
+ is invoked.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</section>
+</li>
+</ul>
+</div>
+</div>
+</main>
+<!-- ========= END OF CLASS DATA ========= -->
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a id="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../index.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CommonsDistributionStagingMojo.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a id="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</nav>
+<p class="legalCopy"><small>Copyright © 2018–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</footer>
+</body>
+</html>