Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,729 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.8.3 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta name="description" content="declaration: package: org.apache.commons.release.plugin.mojos, class: CommonsDistributionStagingMojo"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/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="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<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="sub-nav-list"> +<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> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div> +<h1 title="Class CommonsDistributionStagingMojo" class="title">Class CommonsDistributionStagingMojo</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.maven.plugin.AbstractMojo +<div class="inheritance">org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd> +</dl> +<hr> +<div class="type-signature"><span class="annotations">@Mojo(name="stage-distributions", + defaultPhase=DEPLOY, + threadSafe=true, + aggregator=true) +</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-67">CommonsDistributionStagingMojo</a></span> +<span class="extends-implements">extends org.apache.maven.plugin.AbstractMojo</span></div> +<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 class="notes"> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second even-row-color"><code><a href="#baseDir" class="member-name-link">baseDir</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> that contains a file to the root directory of the working project.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#commonsRcVersion" class="member-name-link">commonsRcVersion</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The RC version of the release.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#commonsReleaseVersion" class="member-name-link">commonsReleaseVersion</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The release version of the artifact to be built.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second odd-row-color"><code><a href="#distCheckoutDirectory" class="member-name-link">distCheckoutDirectory</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The location to which to check out the dist subversion repository under our working directory, which + was given above.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second even-row-color"><code><a href="#distRcVersionDirectory" class="member-name-link">distRcVersionDirectory</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A subdirectory of the dist directory into which we are going to stage the release candidate.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#distServer" class="member-name-link">distServer</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The ID of the server (specified in settings.xml) which should be used for dist authentication.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#distSvnStagingUrl" class="member-name-link">distSvnStagingUrl</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The url of the subversion repository to which we wish the artifacts to be staged.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Boolean.html"; title="class or interface in java.lang" class="external-link">Boolean</a></code></div> +<div class="col-second odd-row-color"><code><a href="#dryRun" class="member-name-link">dryRun</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A boolean that determines whether or not we actually commit the files up to the subversion repository.</div> +</div> +<div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#HEADER_FILE_NAME" class="member-name-link">HEADER_FILE_NAME</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Boolean.html"; title="class or interface in java.lang" class="external-link">Boolean</a></code></div> +<div class="col-second odd-row-color"><code><a href="#isDistModule" class="member-name-link">isDistModule</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#password" class="member-name-link">password</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The password associated with <a href="#username"><code>username</code></a>.</div> +</div> +<div class="col-first odd-row-color"><code>private org.apache.maven.project.MavenProject</code></div> +<div class="col-second odd-row-color"><code><a href="#project" class="member-name-link">project</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at + a given time.</div> +</div> +<div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#README_FILE_NAME" class="member-name-link">README_FILE_NAME</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The name of file generated from the README.vm velocity template to be checked into the dist svn repo.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second odd-row-color"><code><a href="#releaseNotesFile" class="member-name-link">releaseNotesFile</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</div> +</div> +<div class="col-first even-row-color"><code>private org.apache.maven.settings.Settings</code></div> +<div class="col-second even-row-color"><code><a href="#settings" class="member-name-link">settings</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Maven <code>Settings</code>.</div> +</div> +<div class="col-first odd-row-color"><code>private org.apache.maven.settings.crypto.SettingsDecrypter</code></div> +<div class="col-second odd-row-color"><code><a href="#settingsDecrypter" class="member-name-link">settingsDecrypter</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Maven <code>SettingsDecrypter</code> component.</div> +</div> +<div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#SIGNATURE_VALIDATOR_NAME" class="member-name-link">SIGNATURE_VALIDATOR_NAME</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The name of the signature validation shell script to be checked into the dist svn repo.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second odd-row-color"><code><a href="#siteDirectory" class="member-name-link">siteDirectory</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color"><code><a href="#username" class="member-name-link">username</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The username for the distribution subversion repository.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second odd-row-color"><code><a href="#workingDirectory" class="member-name-link">workingDirectory</a></code></div> +<div class="col-last odd-row-color"> +<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> +</div> +</div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>ROLE</code></div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CommonsDistributionStagingMojo</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildReadmeAndHeaderHtmlFiles()" class="member-name-link">buildReadmeAndHeaderHtmlFiles</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)" class="member-name-link">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> copiedReleaseNotes, + org.apache.maven.scm.provider.ScmProvider provider, + org.apache.maven.scm.repository.ScmRepository repository)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<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> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyHeaderAndReadmeToSubdirectories(java.io.File,java.io.File)" class="member-name-link">copyHeaderAndReadmeToSubdirectories</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> headerFile, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> readmeFile)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries + directories.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyReleaseNotesToWorkingDirectory()" class="member-name-link">copyReleaseNotesToWorkingDirectory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<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> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copySignatureValidatorScriptToScmDirectory()" class="member-name-link">copySignatureValidatorScriptToScmDirectory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Copies our <code>signature-validator.sh</code> script into + <code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copySiteToScmDirectory()" class="member-name-link">copySiteToScmDirectory</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listNotHiddenFilesAndDirectories(java.io.File,java.util.List)" class="member-name-link">listNotHiddenFilesAndDirectories</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> directory, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>> files)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Lists all directories and files to a flat list.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBaseDir(java.io.File)" class="member-name-link">setBaseDir</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> baseDir)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<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> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> +<code>getLog, getPluginContext, setLog, setPluginContext</code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="README_FILE_NAME"> +<h3>README_FILE_NAME</h3> +<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-74">README_FILE_NAME</a></span></div> +<div class="block">The name of file generated from the README.vm velocity template to be checked into the dist svn repo.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.README_FILE_NAME">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="HEADER_FILE_NAME"> +<h3>HEADER_FILE_NAME</h3> +<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-77">HEADER_FILE_NAME</a></span></div> +<div class="block">The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.HEADER_FILE_NAME">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="SIGNATURE_VALIDATOR_NAME"> +<h3>SIGNATURE_VALIDATOR_NAME</h3> +<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-80">SIGNATURE_VALIDATOR_NAME</a></span></div> +<div class="block">The name of the signature validation shell script to be checked into the dist svn repo.</div> +<dl class="notes"> +<dt>See Also:</dt> +<dd> +<ul class="see-list"> +<li><a href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.SIGNATURE_VALIDATOR_NAME">Constant Field Values</a></li> +</ul> +</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="project"> +<h3>project</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project}", + required=true) +</span><span class="modifiers">private</span> <span class="return-type">org.apache.maven.project.MavenProject</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-85">project</a></span></div> +<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at + a given time.</div> +</section> +</li> +<li> +<section class="detail" id="baseDir"> +<h3>baseDir</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${basedir}") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-92">baseDir</a></span></div> +<div class="block">The <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><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> +</section> +</li> +<li> +<section class="detail" id="siteDirectory"> +<h3>siteDirectory</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.build.directory}/site", + property="commons.siteOutputDirectory") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-96">siteDirectory</a></span></div> +<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div> +</section> +</li> +<li> +<section class="detail" id="workingDirectory"> +<h3>workingDirectory</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin", + property="commons.outputDirectory") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-103">workingDirectory</a></span></div> +<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> +</section> +</li> +<li> +<section class="detail" id="distCheckoutDirectory"> +<h3>distCheckoutDirectory</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm", + property="commons.distCheckoutDirectory") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-110">distCheckoutDirectory</a></span></div> +<div class="block">The location to which to check out the dist subversion repository under our working directory, which + was given above.</div> +</section> +</li> +<li> +<section class="detail" id="releaseNotesFile"> +<h3>releaseNotesFile</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${basedir}/RELEASE-NOTES.txt", + property="commons.releaseNotesLocation") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-117">releaseNotesFile</a></span></div> +<div class="block">The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</div> +</section> +</li> +<li> +<section class="detail" id="dryRun"> +<h3>dryRun</h3> +<div class="member-signature"><span class="annotations">@Parameter(property="commons.release.dryRun", + defaultValue="false") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Boolean.html"; title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-125">dryRun</a></span></div> +<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> +</section> +</li> +<li> +<section class="detail" id="distSvnStagingUrl"> +<h3>distSvnStagingUrl</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="", + property="commons.distSvnStagingUrl") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-133">distSvnStagingUrl</a></span></div> +<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> +</section> +</li> +<li> +<section class="detail" id="isDistModule"> +<h3>isDistModule</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="false", + property="commons.release.isDistModule") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Boolean.html"; title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-139">isDistModule</a></span></div> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</section> +</li> +<li> +<section class="detail" id="commonsReleaseVersion"> +<h3>commonsReleaseVersion</h3> +<div class="member-signature"><span class="annotations">@Parameter(property="commons.release.version") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-145">commonsReleaseVersion</a></span></div> +<div class="block">The release version of the artifact to be built.</div> +</section> +</li> +<li> +<section class="detail" id="commonsRcVersion"> +<h3>commonsRcVersion</h3> +<div class="member-signature"><span class="annotations">@Parameter(property="commons.rc.version") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-151">commonsRcVersion</a></span></div> +<div class="block">The RC version of the release. For example the first voted on candidate would be "RC1".</div> +</section> +</li> +<li> +<section class="detail" id="distServer"> +<h3>distServer</h3> +<div class="member-signature"><span class="annotations">@Parameter(property="commons.distServer") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-158">distServer</a></span></div> +<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> +</section> +</li> +<li> +<section class="detail" id="username"> +<h3>username</h3> +<div class="member-signature"><span class="annotations">@Parameter(property="user.name") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-164">username</a></span></div> +<div class="block">The username for the distribution subversion repository. This is typically your Apache id.</div> +</section> +</li> +<li> +<section class="detail" id="password"> +<h3>password</h3> +<div class="member-signature"><span class="annotations">@Parameter(property="user.password") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-170">password</a></span></div> +<div class="block">The password associated with <a href="#username"><code>username</code></a>.</div> +</section> +</li> +<li> +<section class="detail" id="settings"> +<h3>settings</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${settings}", + readonly=true, + required=true) +</span><span class="modifiers">private</span> <span class="return-type">org.apache.maven.settings.Settings</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-176">settings</a></span></div> +<div class="block">Maven <code>Settings</code>.</div> +</section> +</li> +<li> +<section class="detail" id="settingsDecrypter"> +<h3>settingsDecrypter</h3> +<div class="member-signature"><span class="annotations">@Component +</span><span class="modifiers">private</span> <span class="return-type">org.apache.maven.settings.crypto.SettingsDecrypter</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-182">settingsDecrypter</a></span></div> +<div class="block">Maven <code>SettingsDecrypter</code> component.</div> +</section> +</li> +<li> +<section class="detail" id="distRcVersionDirectory"> +<h3>distRcVersionDirectory</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-190">distRcVersionDirectory</a></span></div> +<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> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>CommonsDistributionStagingMojo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-71">CommonsDistributionStagingMojo</a></span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="execute()"> +<h3>execute</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-192">execute</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException, +org.apache.maven.plugin.MojoFailureException</span></div> +<dl class="notes"> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> +<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="listNotHiddenFilesAndDirectories(java.io.File,java.util.List)"> +<h3>listNotHiddenFilesAndDirectories</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-279">listNotHiddenFilesAndDirectories</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> directory, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>> files)</span></div> +<div class="block">Lists all directories and files to a flat list.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>directory</code> - <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> containing directory to list</dd> +<dd><code>files</code> - a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> to which to append the files.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copyReleaseNotesToWorkingDirectory()"> +<h3>copyReleaseNotesToWorkingDirectory</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-303">copyReleaseNotesToWorkingDirectory</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<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 class="notes"> +<dt>Returns:</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>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a> occurs as a wrapper so that maven + can properly handle the exception.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)"> +<h3>copyDistributionsIntoScmDirectoryStructureAndAddToSvn</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-342">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> copiedReleaseNotes, + org.apache.maven.scm.provider.ScmProvider provider, + org.apache.maven.scm.repository.ScmRepository repository)</span> + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<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 class="notes"> +<dt>Parameters:</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>Returns:</dt> +<dd>a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a>'s in the directory for the purpose of adding them to the maven + <code>ScmFileSet</code>.</dd> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a> occurs so that Maven can handle it properly.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copySignatureValidatorScriptToScmDirectory()"> +<h3>copySignatureValidatorScriptToScmDirectory</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-384">copySignatureValidatorScriptToScmDirectory</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<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 class="notes"> +<dt>Returns:</dt> +<dd>the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> for the signature-validator.sh</dd> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an error occurs while the resource is being copied</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copySiteToScmDirectory()"> +<h3>copySiteToScmDirectory</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-403">copySiteToScmDirectory</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a>'s contained in + <code>${basedir}/target/commons-release-plugin/scm/site</code>, after the copy is complete.</dd> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the site copying fails for some reason.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildReadmeAndHeaderHtmlFiles()"> +<h3>buildReadmeAndHeaderHtmlFiles</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-437">buildReadmeAndHeaderHtmlFiles</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<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 class="notes"> +<dt>Returns:</dt> +<dd>the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link"><code>List</code></a> of created files above</dd> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a> occurs in the creation of these + files fails.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copyHeaderAndReadmeToSubdirectories(java.io.File,java.io.File)"> +<h3>copyHeaderAndReadmeToSubdirectories</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-489">copyHeaderAndReadmeToSubdirectories</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> headerFile, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> readmeFile)</span> + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<div class="block">Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries + directories.</div> +<dl class="notes"> +<dt>Parameters:</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>Returns:</dt> +<dd>a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link"><code>List</code></a> of created files.</dd> +<dt>Throws:</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> +</section> +</li> +<li> +<section class="detail" id="setBaseDir(java.io.File)"> +<h3>setBaseDir</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-516">setBaseDir</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> baseDir)</span></div> +<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 class="notes"> +<dt>Parameters:</dt> +<dd><code>baseDir</code> - is the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> to be used as the project's root directory when this mojo + is invoked.</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2018-2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</br> <a href="https://commons.apache.org/proper/commons-release-plugin/";>Apache Commons Release Plugin</a> | <a href="https://issues.apache.org/jira/browse/COMMONSSITE";>Issue management</a> | <a href="https://gitbox.apache.org/repos/asf?p=commons-release-plugin.git";>Source repository</a></small></p> +</footer> +</div> +</div> +</body> +</html>
