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 2024/11/03 20:07:41 UTC
svn commit: r72767 [6/35] - in /dev/commons/release-plugin/1.8.3-RC1: ./ binaries/ site/ site/apidocs/ site/apidocs/legal/ site/apidocs/org/ site/apidocs/org/apache/ site/apidocs/org/apache/commons/ site/apidocs/org/apache/commons/release/ site/apidocs...
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,388 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>CommonsSiteCompressionMojo (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: CommonsSiteCompressionMojo">
+<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/CommonsSiteCompressionMojo.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 CommonsSiteCompressionMojo" class="title">Class CommonsSiteCompressionMojo</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.CommonsSiteCompressionMojo</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"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
+@Mojo(name="compress-site",
+ defaultPhase=POST_SITE,
+ 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/CommonsSiteCompressionMojo.html#line-46">CommonsSiteCompressionMojo</a></span>
+<span class="extends-implements">extends org.apache.maven.plugin.AbstractMojo</span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
+<div class="deprecation-comment">- as we no longer wish to compress the site, we are going to put this functionality in the
+ <a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div>
+</div>
+<div class="block">Takes the built <code>./target/site</code> directory and compresses it to
+ <code>./target/commons-release-plugin/site.zip</code>.</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/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"><span class="deprecated-label">Deprecated.</span></div>
+<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/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"><code><a href="#filesToCompress" class="member-name-link">filesToCompress</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">The list of files to compress into the site.zip file.</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/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
+<div class="col-second even-row-color"><code><a href="#isDistModule" class="member-name-link">isDistModule</a></code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+<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 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"><span class="deprecated-label">Deprecated.</span></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="#workingDirectory" class="member-name-link">workingDirectory</a></code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">The working directory for the plugin which, assuming the maven uses the default
+ <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</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">CommonsSiteCompressionMojo</a>()</code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+ </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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.
tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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 method-summary-table-tab6"><code>private void</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)" class="member-name-link">addToZip</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> directoryToZip,
+ <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> file,
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/zip/ZipOutputStream.html" title="class or interface in java.util.zip" class="external-link">ZipOutputStream</a> zos)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by
+ <code>zos</code>.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+ </div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>private void</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getAllSiteFiles(java.io.File,java.util.List)" class="member-name-link">getAllSiteFiles</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> siteDirectory,
+ <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>> filesToCompress)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">By default this method iterates across the <code>target/site</code> directory and adds all the files
+ to the <a href="#filesToCompress"><code>filesToCompress</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>.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>private void</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#writeZipFile(java.io.File,java.io.File,java.util.List)" class="member-name-link">writeZipFile</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> outputDirectory,
+ <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> directoryToZip,
+ <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>> fileList)</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file
+ in the <code>workingDirectory</code>.</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="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/CommonsSiteCompressionMojo.html#line-57">workingDirectory</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">The working directory for the plugin which, assuming the maven uses the default
+ <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</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/CommonsSiteCompressionMojo.html#line-63">siteDirectory</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></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/CommonsSiteCompressionMojo.html#line-72">distSvnStagingUrl</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</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</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/CommonsSiteCompressionMojo.html#line-78">isDistModule</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</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="filesToCompress">
+<h3>filesToCompress</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/CommonsSiteCompressionMojo.html#line-84">filesToCompress</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">The list of files to compress into the site.zip file.</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>CommonsSiteCompressionMojo</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-51">CommonsSiteCompressionMojo</a></span>()</div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</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/CommonsSiteCompressionMojo.html#line-86">execute</a></span>()
+ throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException,
+org.apache.maven.plugin.MojoFailureException</span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</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="getAllSiteFiles(java.io.File,java.util.List)">
+<h3>getAllSiteFiles</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/CommonsSiteCompressionMojo.html#line-127">getAllSiteFiles</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> siteDirectory,
+ <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>> filesToCompress)</span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">By default this method iterates across the <code>target/site</code> directory and adds all the files
+ to the <a href="#filesToCompress"><code>filesToCompress</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>.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>siteDirectory</code> - 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 represents the <code>target/site</code> directory.</dd>
+<dd><code>filesToCompress</code> - 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> to which to add all the files.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="writeZipFile(java.io.File,java.io.File,java.util.List)">
+<h3>writeZipFile</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/CommonsSiteCompressionMojo.html#line-148">writeZipFile</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> outputDirectory,
+ <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> directoryToZip,
+ <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>> fileList)</span>
+ throws <span class="exceptions"><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">IOException</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file
+ in the <code>workingDirectory</code>.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>outputDirectory</code> - is 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"><code>File</code></a> representing the place to put the site.zip file.</dd>
+<dd><code>directoryToZip</code> - is 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"><code>File</code></a> representing the directory of the site (normally
+ <code>target/site</code>).</dd>
+<dd><code>fileList</code> - the list of files to be zipped up, generally generated by
+ <a href="#getAllSiteFiles(java.io.File,java.util.List)"><code>getAllSiteFiles(File, List)</code></a>.</dd>
+<dt>Throws:</dt>
+<dd><code><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">IOException</a></code> - when the copying of the files goes incorrectly.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)">
+<h3>addToZip</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/CommonsSiteCompressionMojo.html#line-171">addToZip</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> directoryToZip,
+ <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> file,
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/zip/ZipOutputStream.html" title="class or interface in java.util.zip" class="external-link">ZipOutputStream</a> zos)</span>
+ throws <span class="exceptions"><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">IOException</a></span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
+<div class="block">Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by
+ <code>zos</code>.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>directoryToZip</code> - 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"><code>File</code></a> representing the directory from which the file exists that we are
+ compressing. Generally this is <code>target/site</code>.</dd>
+<dd><code>file</code> - 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"><code>File</code></a> to add to the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/zip/ZipOutputStream.html" title="class or interface in java.util.zip" class="external-link"><code>ZipOutputStream</code></a> <code>zos</code>.</dd>
+<dd><code>zos</code> - the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/zip/ZipOutputStream.html" title="class or interface in java.util.zip" class="external-link"><code>ZipOutputStream</code></a> to which to add our <code>file</code>.</dd>
+<dt>Throws:</dt>
+<dd><code><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">IOException</a></code> - if adding the <code>file</code> doesn't work out properly.</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>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,374 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>CommonsStagingCleanupMojo (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: CommonsStagingCleanupMojo">
+<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/CommonsStagingCleanupMojo.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 CommonsStagingCleanupMojo" class="title">Class CommonsStagingCleanupMojo</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.CommonsStagingCleanupMojo</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="clean-staging",
+ defaultPhase=POST_CLEAN,
+ 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/CommonsStagingCleanupMojo.html#line-53">CommonsStagingCleanupMojo</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, checks whether anything exists in the
+ distribution location, and if it is non-empty it deletes all the resources there.</div>
+<dl class="notes">
+<dt>Since:</dt>
+<dd>1.6</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="#distCleanupDirectory" class="member-name-link">distCleanupDirectory</a></code></div>
+<div class="col-last even-row-color">
+<div class="block">The location to which to checkout the dist subversion repository under our working directory, which
+ was given above.</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 <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 even-row-color"><code><a href="#isDistModule" class="member-name-link">isDistModule</a></code></div>
+<div class="col-last even-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 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="#password" class="member-name-link">password</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block">The password associated with <a href="CommonsDistributionStagingMojo.html#username"><code>CommonsDistributionStagingMojo.username</code></a>.</div>
+</div>
+<div class="col-first even-row-color"><code>private org.apache.maven.project.MavenProject</code></div>
+<div class="col-second even-row-color"><code><a href="#project" class="member-name-link">project</a></code></div>
+<div class="col-last even-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 odd-row-color"><code>private org.apache.maven.settings.Settings</code></div>
+<div class="col-second odd-row-color"><code><a href="#settings" class="member-name-link">settings</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block">Maven <code>Settings</code>.</div>
+</div>
+<div class="col-first even-row-color"><code>private org.apache.maven.settings.crypto.SettingsDecrypter</code></div>
+<div class="col-second even-row-color"><code><a href="#settingsDecrypter" class="member-name-link">settingsDecrypter</a></code></div>
+<div class="col-last even-row-color">
+<div class="block">Maven <code>SettingsDecrypter</code> component.</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="#username" class="member-name-link">username</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block">The username for the distribution subversion repository.</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="#workingDirectory" class="member-name-link">workingDirectory</a></code></div>
+<div class="col-last even-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">CommonsStagingCleanupMojo</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>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>
+</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="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/CommonsStagingCleanupMojo.html#line-63">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="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/CommonsStagingCleanupMojo.html#line-70">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="distCleanupDirectory">
+<h3>distCleanupDirectory</h3>
+<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm-cleanup",
+ property="commons.distCleanupDirectory")
+</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/CommonsStagingCleanupMojo.html#line-77">distCleanupDirectory</a></span></div>
+<div class="block">The location to which to checkout the dist subversion repository under our working directory, which
+ was given above. We then do an SVN delete on all the directories in this repository.</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/CommonsStagingCleanupMojo.html#line-86">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/CommonsStagingCleanupMojo.html#line-94">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/CommonsStagingCleanupMojo.html#line-100">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="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/CommonsStagingCleanupMojo.html#line-107">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/CommonsStagingCleanupMojo.html#line-113">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/CommonsStagingCleanupMojo.html#line-119">password</a></span></div>
+<div class="block">The password associated with <a href="CommonsDistributionStagingMojo.html#username"><code>CommonsDistributionStagingMojo.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/CommonsStagingCleanupMojo.html#line-125">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/CommonsStagingCleanupMojo.html#line-131">settingsDecrypter</a></span></div>
+<div class="block">Maven <code>SettingsDecrypter</code> component.</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>CommonsStagingCleanupMojo</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#line-57">CommonsStagingCleanupMojo</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/CommonsStagingCleanupMojo.html#line-134">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>
+</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>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo (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="use: package: org.apache.commons.release.plugin.mojos, class: CommonsDistributionDetachmentMojo">
+<meta name="generator" content="javadoc/ClassUseWriter">
+<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-use-page">
+<script type="text/javascript">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><a href="../CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li>
+<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<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">
+<div class="header">
+<h1 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo</h1>
+</div>
+No usage of org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo</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>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionStagingMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionStagingMojo.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionStagingMojo.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Uses of Class org.apache.commons.release.plugin.mojos.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="use: package: org.apache.commons.release.plugin.mojos, class: CommonsDistributionStagingMojo">
+<meta name="generator" content="javadoc/ClassUseWriter">
+<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-use-page">
+<script type="text/javascript">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><a href="../CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li>
+<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<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">
+<div class="header">
+<h1 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</h1>
+</div>
+No usage of org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</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>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsSiteCompressionMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsSiteCompressionMojo.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsSiteCompressionMojo.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Uses of Class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo (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="use: package: org.apache.commons.release.plugin.mojos, class: CommonsSiteCompressionMojo">
+<meta name="generator" content="javadoc/ClassUseWriter">
+<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-use-page">
+<script type="text/javascript">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><a href="../CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li>
+<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<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">
+<div class="header">
+<h1 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</h1>
+</div>
+No usage of org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</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>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsStagingCleanupMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsStagingCleanupMojo.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/class-use/CommonsStagingCleanupMojo.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Uses of Class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo (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="use: package: org.apache.commons.release.plugin.mojos, class: CommonsStagingCleanupMojo">
+<meta name="generator" content="javadoc/ClassUseWriter">
+<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-use-page">
+<script type="text/javascript">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><a href="../CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li>
+<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<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">
+<div class="header">
+<h1 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo</h1>
+</div>
+No usage of org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo</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>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/package-summary.html
==============================================================================
--- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/package-summary.html (added)
+++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/package-summary.html Sun Nov 3 20:07:40 2024
@@ -0,0 +1,137 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>org.apache.commons.release.plugin.mojos (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">
+<meta name="generator" content="javadoc/PackageWriterImpl">
+<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="package-declaration-page">
+<script type="text/javascript">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 class="nav-bar-cell1-rev">Package</li>
+<li>Class</li>
+<li><a href="package-use.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#package">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div>
+<ul class="sub-nav-list">
+<li>Package: </li>
+<li><a href="#package-description">Description</a> | </li>
+<li><a href="#related-package-summary">Related Packages</a> | </li>
+<li><a href="#class-summary">Classes and Interfaces</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">
+<div class="header">
+<h1 title="Package org.apache.commons.release.plugin.mojos" class="title">Package org.apache.commons.release.plugin.mojos</h1>
+</div>
+<hr>
+<div class="package-signature">package <span class="element-name">org.apache.commons.release.plugin.mojos</span></div>
+<section class="package-description" id="package-description">
+<div class="block">This package contains all the maven mojos for the commons-release-plugin. Currently
+ this only has the following mojos:
+ <ul>
+ <li><a href="CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionDetachmentMojo</code></a>,</li>
+ <li><a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>, and</li>
+ <li><a href="CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsSiteCompressionMojo</code></a></li>
+ </ul></div>
+<dl class="notes">
+<dt>Since:</dt>
+<dd>1.0</dd>
+</dl>
+</section>
+<section class="summary">
+<ul class="summary-list">
+<li>
+<div id="related-package-summary">
+<div class="caption"><span>Related Packages</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Package</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.commons.release.plugin</a></div>
+<div class="col-last even-row-color">
+<div class="block">Base package for the commons-release-plugin.</div>
+</div>
+<div class="col-first odd-row-color"><a href="../velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></div>
+<div class="col-last odd-row-color">
+<div class="block">Contains classes that take our velocity templates and render's them to a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Writer.html" title="class or interface in java.io" class="external-link"><code>Writer</code></a>
+ class.</div>
+</div>
+</div>
+</div>
+</li>
+<li>
+<div id="class-summary">
+<div class="caption"><span>Classes</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Class</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></div>
+<div class="col-last even-row-color class-summary class-summary-tab2">
+<div class="block">The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin,
+ which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts
+ in the dev distribution location for Apache projects.</div>
+</div>
+<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></div>
+<div class="col-last odd-row-color class-summary class-summary-tab2">
+<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.</div>
+</div>
+<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></div>
+<div class="col-last even-row-color class-summary class-summary-tab2">Deprecated.
+<div class="deprecation-comment">- as we no longer wish to compress the site, we are going to put this functionality in the
+ <a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div>
+</div>
+<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></div>
+<div class="col-last odd-row-color class-summary class-summary-tab2">
+<div class="block">This class checks out the dev distribution location, checks whether anything exists in the
+ distribution location, and if it is non-empty it deletes all the resources there.</div>
+</div>
+</div>
+</div>
+</li>
+</ul>
+</section>
+</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>