You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by gg...@apache.org on 2022/03/17 19:32:31 UTC
svn commit: r1078854 [6/25] - in /websites/production/commons/content/proper/commons-release-plugin: ./ apidocs/ apidocs/org/apache/commons/release/plugin/ apidocs/org/apache/commons/release/plugin/class-use/ apidocs/org/apache/commons/release/plugin/m...
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Thu Mar 17 19:32:29 2022
@@ -25,169 +25,171 @@
<span class="sourceLineNo">017</span>package org.apache.commons.release.plugin.mojos;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
-<span class="sourceLineNo">020</span>import java.io.FileInputStream;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import java.io.FileOutputStream;<a name="line.21"></a>
-<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
-<span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a>
-<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
-<span class="sourceLineNo">025</span>import java.util.zip.ZipEntry;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import java.util.zip.ZipOutputStream;<a name="line.26"></a>
-<span class="sourceLineNo">027</span><a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.commons.io.IOUtils;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.apache.commons.lang3.StringUtils;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.maven.plugin.AbstractMojo;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.maven.plugin.MojoExecutionException;<a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.maven.plugin.MojoFailureException;<a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.maven.plugins.annotations.LifecyclePhase;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import org.apache.maven.plugins.annotations.Mojo;<a name="line.34"></a>
-<span class="sourceLineNo">035</span>import org.apache.maven.plugins.annotations.Parameter;<a name="line.35"></a>
-<span class="sourceLineNo">036</span><a name="line.36"></a>
-<span class="sourceLineNo">037</span>/**<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * Takes the built <code>./target/site</code> directory and compresses it to<a name="line.38"></a>
-<span class="sourceLineNo">039</span> * <code>./target/commons-release-plugin/site.zip</code>.<a name="line.39"></a>
-<span class="sourceLineNo">040</span> *<a name="line.40"></a>
-<span class="sourceLineNo">041</span> * @author chtompki<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * @since 1.0<a name="line.42"></a>
-<span class="sourceLineNo">043</span> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the<a name="line.43"></a>
-<span class="sourceLineNo">044</span> * {@link CommonsDistributionStagingMojo}.<a name="line.44"></a>
-<span class="sourceLineNo">045</span> */<a name="line.45"></a>
-<span class="sourceLineNo">046</span>@Deprecated<a name="line.46"></a>
-<span class="sourceLineNo">047</span>@Mojo(name = "compress-site",<a name="line.47"></a>
-<span class="sourceLineNo">048</span> defaultPhase = LifecyclePhase.POST_SITE,<a name="line.48"></a>
-<span class="sourceLineNo">049</span> threadSafe = true,<a name="line.49"></a>
-<span class="sourceLineNo">050</span> aggregator = true)<a name="line.50"></a>
-<span class="sourceLineNo">051</span>public class CommonsSiteCompressionMojo extends AbstractMojo {<a name="line.51"></a>
-<span class="sourceLineNo">052</span><a name="line.52"></a>
-<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
-<span class="sourceLineNo">054</span> * The working directory for the plugin which, assuming the maven uses the default<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.<a name="line.55"></a>
-<span class="sourceLineNo">056</span> */<a name="line.56"></a>
-<span class="sourceLineNo">057</span> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",<a name="line.57"></a>
-<span class="sourceLineNo">058</span> property = "commons.outputDirectory")<a name="line.58"></a>
-<span class="sourceLineNo">059</span> private File workingDirectory;<a name="line.59"></a>
-<span class="sourceLineNo">060</span><a name="line.60"></a>
-<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
-<span class="sourceLineNo">062</span> */<a name="line.62"></a>
-<span class="sourceLineNo">063</span> @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")<a name="line.63"></a>
-<span class="sourceLineNo">064</span> private File siteDirectory;<a name="line.64"></a>
-<span class="sourceLineNo">065</span><a name="line.65"></a>
-<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
-<span class="sourceLineNo">067</span> * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly<a name="line.67"></a>
-<span class="sourceLineNo">068</span> * this would need to be of the form:<a name="line.68"></a>
-<span class="sourceLineNo">069</span> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the<a name="line.69"></a>
-<span class="sourceLineNo">070</span> * substring <code>https</code> is a requirement.<a name="line.70"></a>
-<span class="sourceLineNo">071</span> */<a name="line.71"></a>
-<span class="sourceLineNo">072</span> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")<a name="line.72"></a>
-<span class="sourceLineNo">073</span> private String distSvnStagingUrl;<a name="line.73"></a>
-<span class="sourceLineNo">074</span><a name="line.74"></a>
-<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.<a name="line.76"></a>
-<span class="sourceLineNo">077</span> */<a name="line.77"></a>
-<span class="sourceLineNo">078</span> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")<a name="line.78"></a>
-<span class="sourceLineNo">079</span> private Boolean isDistModule;<a name="line.79"></a>
-<span class="sourceLineNo">080</span><a name="line.80"></a>
-<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
-<span class="sourceLineNo">082</span> * The list of files to compress into the site.zip file.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> */<a name="line.83"></a>
-<span class="sourceLineNo">084</span> private List<File> filesToCompress;<a name="line.84"></a>
-<span class="sourceLineNo">085</span><a name="line.85"></a>
-<span class="sourceLineNo">086</span> @Override<a name="line.86"></a>
-<span class="sourceLineNo">087</span> public void execute() throws MojoExecutionException, MojoFailureException {<a name="line.87"></a>
-<span class="sourceLineNo">088</span> if (!isDistModule) {<a name="line.88"></a>
-<span class="sourceLineNo">089</span> getLog().info("This module is marked as a non distribution "<a name="line.89"></a>
-<span class="sourceLineNo">090</span> + "or assembly module, and the plugin will not run.");<a name="line.90"></a>
-<span class="sourceLineNo">091</span> return;<a name="line.91"></a>
-<span class="sourceLineNo">092</span> }<a name="line.92"></a>
-<span class="sourceLineNo">093</span> if (StringUtils.isEmpty(distSvnStagingUrl)) {<a name="line.93"></a>
-<span class="sourceLineNo">094</span> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");<a name="line.94"></a>
-<span class="sourceLineNo">095</span> return;<a name="line.95"></a>
-<span class="sourceLineNo">096</span> }<a name="line.96"></a>
-<span class="sourceLineNo">097</span> if (!siteDirectory.exists()) {<a name="line.97"></a>
-<span class="sourceLineNo">098</span> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");<a name="line.98"></a>
-<span class="sourceLineNo">099</span> throw new MojoFailureException(<a name="line.99"></a>
-<span class="sourceLineNo">100</span> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."<a name="line.100"></a>
-<span class="sourceLineNo">101</span> );<a name="line.101"></a>
-<span class="sourceLineNo">102</span> }<a name="line.102"></a>
-<span class="sourceLineNo">103</span> if (!workingDirectory.exists()) {<a name="line.103"></a>
-<span class="sourceLineNo">104</span> getLog().info("Current project contains no distributions. Not executing.");<a name="line.104"></a>
-<span class="sourceLineNo">105</span> return;<a name="line.105"></a>
-<span class="sourceLineNo">106</span> }<a name="line.106"></a>
-<span class="sourceLineNo">107</span> try {<a name="line.107"></a>
-<span class="sourceLineNo">108</span> filesToCompress = new ArrayList<>();<a name="line.108"></a>
-<span class="sourceLineNo">109</span> getAllSiteFiles(siteDirectory, filesToCompress);<a name="line.109"></a>
-<span class="sourceLineNo">110</span> writeZipFile(workingDirectory, siteDirectory, filesToCompress);<a name="line.110"></a>
-<span class="sourceLineNo">111</span> } catch (final IOException e) {<a name="line.111"></a>
-<span class="sourceLineNo">112</span> getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);<a name="line.112"></a>
-<span class="sourceLineNo">113</span> throw new MojoExecutionException(<a name="line.113"></a>
-<span class="sourceLineNo">114</span> "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),<a name="line.114"></a>
-<span class="sourceLineNo">115</span> e<a name="line.115"></a>
-<span class="sourceLineNo">116</span> );<a name="line.116"></a>
-<span class="sourceLineNo">117</span> }<a name="line.117"></a>
-<span class="sourceLineNo">118</span> }<a name="line.118"></a>
-<span class="sourceLineNo">119</span><a name="line.119"></a>
-<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
-<span class="sourceLineNo">121</span> * By default this method iterates across the <code>target/site</code> directory and adds all of the files<a name="line.121"></a>
-<span class="sourceLineNo">122</span> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.<a name="line.122"></a>
-<span class="sourceLineNo">123</span> *<a name="line.123"></a>
-<span class="sourceLineNo">124</span> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.<a name="line.124"></a>
-<span class="sourceLineNo">125</span> * @param filesToCompress the {@link List} to which to add all the files.<a name="line.125"></a>
-<span class="sourceLineNo">126</span> */<a name="line.126"></a>
-<span class="sourceLineNo">127</span> private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {<a name="line.127"></a>
-<span class="sourceLineNo">128</span> final File[] files = siteDirectory.listFiles();<a name="line.128"></a>
-<span class="sourceLineNo">129</span> for (final File file : files) {<a name="line.129"></a>
-<span class="sourceLineNo">130</span> filesToCompress.add(file);<a name="line.130"></a>
-<span class="sourceLineNo">131</span> if (file.isDirectory()) {<a name="line.131"></a>
-<span class="sourceLineNo">132</span> getAllSiteFiles(file, filesToCompress);<a name="line.132"></a>
-<span class="sourceLineNo">133</span> }<a name="line.133"></a>
-<span class="sourceLineNo">134</span> }<a name="line.134"></a>
-<span class="sourceLineNo">135</span> }<a name="line.135"></a>
-<span class="sourceLineNo">136</span><a name="line.136"></a>
-<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * A helper method for writing all of the files in our <code>fileList</code> to a <code>site.zip</code> file<a name="line.138"></a>
-<span class="sourceLineNo">139</span> * in the <code>workingDirectory</code>.<a name="line.139"></a>
-<span class="sourceLineNo">140</span> *<a name="line.140"></a>
-<span class="sourceLineNo">141</span> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * @param directoryToZip is a {@link File} representing the directory of the site (normally<a name="line.142"></a>
-<span class="sourceLineNo">143</span> * <code>target/site</code>).<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * @param fileList the list of files to be zipped up, generally generated by<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * @throws IOException when the copying of the files goes incorrectly.<a name="line.146"></a>
-<span class="sourceLineNo">147</span> */<a name="line.147"></a>
-<span class="sourceLineNo">148</span> private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)<a name="line.148"></a>
-<span class="sourceLineNo">149</span> throws IOException {<a name="line.149"></a>
-<span class="sourceLineNo">150</span> try (FileOutputStream fos = new FileOutputStream(outputDirectory.getAbsolutePath() + "/site.zip");<a name="line.150"></a>
-<span class="sourceLineNo">151</span> ZipOutputStream zos = new ZipOutputStream(fos)) {<a name="line.151"></a>
-<span class="sourceLineNo">152</span> for (final File file : fileList) {<a name="line.152"></a>
-<span class="sourceLineNo">153</span> if (!file.isDirectory()) { // we only zip files, not directories<a name="line.153"></a>
-<span class="sourceLineNo">154</span> addToZip(directoryToZip, file, zos);<a name="line.154"></a>
-<span class="sourceLineNo">155</span> }<a name="line.155"></a>
-<span class="sourceLineNo">156</span> }<a name="line.156"></a>
-<span class="sourceLineNo">157</span> }<a name="line.157"></a>
-<span class="sourceLineNo">158</span> }<a name="line.158"></a>
-<span class="sourceLineNo">159</span><a name="line.159"></a>
-<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
-<span class="sourceLineNo">161</span> * Given the <code>directoryToZip</code> we add the <code>file</code> to the zip archive represented by<a name="line.161"></a>
-<span class="sourceLineNo">162</span> * <code>zos</code>.<a name="line.162"></a>
-<span class="sourceLineNo">163</span> *<a name="line.163"></a>
-<span class="sourceLineNo">164</span> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * compressing. Generally this is <code>target/site</code>.<a name="line.165"></a>
-<span class="sourceLineNo">166</span> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.<a name="line.166"></a>
-<span class="sourceLineNo">167</span> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * @throws IOException if adding the <code>file</code> doesn't work out properly.<a name="line.168"></a>
-<span class="sourceLineNo">169</span> */<a name="line.169"></a>
-<span class="sourceLineNo">170</span> private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {<a name="line.170"></a>
-<span class="sourceLineNo">171</span> try (FileInputStream fis = new FileInputStream(file)) {<a name="line.171"></a>
-<span class="sourceLineNo">172</span> // we want the zipEntry's path to be a relative path that is relative<a name="line.172"></a>
-<span class="sourceLineNo">173</span> // to the directory being zipped, so chop off the rest of the path<a name="line.173"></a>
-<span class="sourceLineNo">174</span> final String zipFilePath = file.getCanonicalPath().substring(<a name="line.174"></a>
-<span class="sourceLineNo">175</span> directoryToZip.getCanonicalPath().length() + 1,<a name="line.175"></a>
-<span class="sourceLineNo">176</span> file.getCanonicalPath().length());<a name="line.176"></a>
-<span class="sourceLineNo">177</span> final ZipEntry zipEntry = new ZipEntry(zipFilePath);<a name="line.177"></a>
-<span class="sourceLineNo">178</span> zos.putNextEntry(zipEntry);<a name="line.178"></a>
-<span class="sourceLineNo">179</span> IOUtils.copy(fis, zos);<a name="line.179"></a>
-<span class="sourceLineNo">180</span> }<a name="line.180"></a>
-<span class="sourceLineNo">181</span> }<a name="line.181"></a>
-<span class="sourceLineNo">182</span>}<a name="line.182"></a>
+<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import java.io.InputStream;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import java.io.OutputStream;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import java.nio.file.Files;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import java.util.zip.ZipEntry;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import java.util.zip.ZipOutputStream;<a name="line.27"></a>
+<span class="sourceLineNo">028</span><a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.commons.io.IOUtils;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.commons.lang3.StringUtils;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.maven.plugin.AbstractMojo;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.maven.plugin.MojoExecutionException;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import org.apache.maven.plugin.MojoFailureException;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import org.apache.maven.plugins.annotations.LifecyclePhase;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import org.apache.maven.plugins.annotations.Mojo;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import org.apache.maven.plugins.annotations.Parameter;<a name="line.36"></a>
+<span class="sourceLineNo">037</span><a name="line.37"></a>
+<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * Takes the built <code>./target/site</code> directory and compresses it to<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * <code>./target/commons-release-plugin/site.zip</code>.<a name="line.40"></a>
+<span class="sourceLineNo">041</span> *<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * @author chtompki<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * @since 1.0<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * {@link CommonsDistributionStagingMojo}.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> */<a name="line.46"></a>
+<span class="sourceLineNo">047</span>@Deprecated<a name="line.47"></a>
+<span class="sourceLineNo">048</span>@Mojo(name = "compress-site",<a name="line.48"></a>
+<span class="sourceLineNo">049</span> defaultPhase = LifecyclePhase.POST_SITE,<a name="line.49"></a>
+<span class="sourceLineNo">050</span> threadSafe = true,<a name="line.50"></a>
+<span class="sourceLineNo">051</span> aggregator = true)<a name="line.51"></a>
+<span class="sourceLineNo">052</span>public class CommonsSiteCompressionMojo extends AbstractMojo {<a name="line.52"></a>
+<span class="sourceLineNo">053</span><a name="line.53"></a>
+<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * The working directory for the plugin which, assuming the maven uses the default<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> */<a name="line.57"></a>
+<span class="sourceLineNo">058</span> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",<a name="line.58"></a>
+<span class="sourceLineNo">059</span> property = "commons.outputDirectory")<a name="line.59"></a>
+<span class="sourceLineNo">060</span> private File workingDirectory;<a name="line.60"></a>
+<span class="sourceLineNo">061</span><a name="line.61"></a>
+<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
+<span class="sourceLineNo">063</span> */<a name="line.63"></a>
+<span class="sourceLineNo">064</span> @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")<a name="line.64"></a>
+<span class="sourceLineNo">065</span> private File siteDirectory;<a name="line.65"></a>
+<span class="sourceLineNo">066</span><a name="line.66"></a>
+<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * this would need to be of the form:<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * substring <code>https</code> is a requirement.<a name="line.71"></a>
+<span class="sourceLineNo">072</span> */<a name="line.72"></a>
+<span class="sourceLineNo">073</span> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")<a name="line.73"></a>
+<span class="sourceLineNo">074</span> private String distSvnStagingUrl;<a name="line.74"></a>
+<span class="sourceLineNo">075</span><a name="line.75"></a>
+<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.<a name="line.77"></a>
+<span class="sourceLineNo">078</span> */<a name="line.78"></a>
+<span class="sourceLineNo">079</span> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")<a name="line.79"></a>
+<span class="sourceLineNo">080</span> private Boolean isDistModule;<a name="line.80"></a>
+<span class="sourceLineNo">081</span><a name="line.81"></a>
+<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * The list of files to compress into the site.zip file.<a name="line.83"></a>
+<span class="sourceLineNo">084</span> */<a name="line.84"></a>
+<span class="sourceLineNo">085</span> private List<File> filesToCompress;<a name="line.85"></a>
+<span class="sourceLineNo">086</span><a name="line.86"></a>
+<span class="sourceLineNo">087</span> @Override<a name="line.87"></a>
+<span class="sourceLineNo">088</span> public void execute() throws MojoExecutionException, MojoFailureException {<a name="line.88"></a>
+<span class="sourceLineNo">089</span> if (!isDistModule) {<a name="line.89"></a>
+<span class="sourceLineNo">090</span> getLog().info("This module is marked as a non distribution "<a name="line.90"></a>
+<span class="sourceLineNo">091</span> + "or assembly module, and the plugin will not run.");<a name="line.91"></a>
+<span class="sourceLineNo">092</span> return;<a name="line.92"></a>
+<span class="sourceLineNo">093</span> }<a name="line.93"></a>
+<span class="sourceLineNo">094</span> if (StringUtils.isEmpty(distSvnStagingUrl)) {<a name="line.94"></a>
+<span class="sourceLineNo">095</span> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");<a name="line.95"></a>
+<span class="sourceLineNo">096</span> return;<a name="line.96"></a>
+<span class="sourceLineNo">097</span> }<a name="line.97"></a>
+<span class="sourceLineNo">098</span> if (!siteDirectory.exists()) {<a name="line.98"></a>
+<span class="sourceLineNo">099</span> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");<a name="line.99"></a>
+<span class="sourceLineNo">100</span> throw new MojoFailureException(<a name="line.100"></a>
+<span class="sourceLineNo">101</span> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."<a name="line.101"></a>
+<span class="sourceLineNo">102</span> );<a name="line.102"></a>
+<span class="sourceLineNo">103</span> }<a name="line.103"></a>
+<span class="sourceLineNo">104</span> if (!workingDirectory.exists()) {<a name="line.104"></a>
+<span class="sourceLineNo">105</span> getLog().info("Current project contains no distributions. Not executing.");<a name="line.105"></a>
+<span class="sourceLineNo">106</span> return;<a name="line.106"></a>
+<span class="sourceLineNo">107</span> }<a name="line.107"></a>
+<span class="sourceLineNo">108</span> try {<a name="line.108"></a>
+<span class="sourceLineNo">109</span> filesToCompress = new ArrayList<>();<a name="line.109"></a>
+<span class="sourceLineNo">110</span> getAllSiteFiles(siteDirectory, filesToCompress);<a name="line.110"></a>
+<span class="sourceLineNo">111</span> writeZipFile(workingDirectory, siteDirectory, filesToCompress);<a name="line.111"></a>
+<span class="sourceLineNo">112</span> } catch (final IOException e) {<a name="line.112"></a>
+<span class="sourceLineNo">113</span> getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);<a name="line.113"></a>
+<span class="sourceLineNo">114</span> throw new MojoExecutionException(<a name="line.114"></a>
+<span class="sourceLineNo">115</span> "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),<a name="line.115"></a>
+<span class="sourceLineNo">116</span> e<a name="line.116"></a>
+<span class="sourceLineNo">117</span> );<a name="line.117"></a>
+<span class="sourceLineNo">118</span> }<a name="line.118"></a>
+<span class="sourceLineNo">119</span> }<a name="line.119"></a>
+<span class="sourceLineNo">120</span><a name="line.120"></a>
+<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
+<span class="sourceLineNo">122</span> * By default this method iterates across the <code>target/site</code> directory and adds all of the files<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.<a name="line.123"></a>
+<span class="sourceLineNo">124</span> *<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * @param filesToCompress the {@link List} to which to add all the files.<a name="line.126"></a>
+<span class="sourceLineNo">127</span> */<a name="line.127"></a>
+<span class="sourceLineNo">128</span> private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {<a name="line.128"></a>
+<span class="sourceLineNo">129</span> final File[] files = siteDirectory.listFiles();<a name="line.129"></a>
+<span class="sourceLineNo">130</span> for (final File file : files) {<a name="line.130"></a>
+<span class="sourceLineNo">131</span> filesToCompress.add(file);<a name="line.131"></a>
+<span class="sourceLineNo">132</span> if (file.isDirectory()) {<a name="line.132"></a>
+<span class="sourceLineNo">133</span> getAllSiteFiles(file, filesToCompress);<a name="line.133"></a>
+<span class="sourceLineNo">134</span> }<a name="line.134"></a>
+<span class="sourceLineNo">135</span> }<a name="line.135"></a>
+<span class="sourceLineNo">136</span> }<a name="line.136"></a>
+<span class="sourceLineNo">137</span><a name="line.137"></a>
+<span class="sourceLineNo">138</span> /**<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * A helper method for writing all of the files in our <code>fileList</code> to a <code>site.zip</code> file<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * in the <code>workingDirectory</code>.<a name="line.140"></a>
+<span class="sourceLineNo">141</span> *<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * @param directoryToZip is a {@link File} representing the directory of the site (normally<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * <code>target/site</code>).<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * @param fileList the list of files to be zipped up, generally generated by<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * @throws IOException when the copying of the files goes incorrectly.<a name="line.147"></a>
+<span class="sourceLineNo">148</span> */<a name="line.148"></a>
+<span class="sourceLineNo">149</span> private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)<a name="line.149"></a>
+<span class="sourceLineNo">150</span> throws IOException {<a name="line.150"></a>
+<span class="sourceLineNo">151</span> try (OutputStream fos = Files.newOutputStream(new File(outputDirectory.getAbsolutePath() + "/site.zip")<a name="line.151"></a>
+<span class="sourceLineNo">152</span> .toPath());<a name="line.152"></a>
+<span class="sourceLineNo">153</span> ZipOutputStream zos = new ZipOutputStream(fos)) {<a name="line.153"></a>
+<span class="sourceLineNo">154</span> for (final File file : fileList) {<a name="line.154"></a>
+<span class="sourceLineNo">155</span> if (!file.isDirectory()) { // we only zip files, not directories<a name="line.155"></a>
+<span class="sourceLineNo">156</span> addToZip(directoryToZip, file, zos);<a name="line.156"></a>
+<span class="sourceLineNo">157</span> }<a name="line.157"></a>
+<span class="sourceLineNo">158</span> }<a name="line.158"></a>
+<span class="sourceLineNo">159</span> }<a name="line.159"></a>
+<span class="sourceLineNo">160</span> }<a name="line.160"></a>
+<span class="sourceLineNo">161</span><a name="line.161"></a>
+<span class="sourceLineNo">162</span> /**<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * Given the <code>directoryToZip</code> we add the <code>file</code> to the zip archive represented by<a name="line.163"></a>
+<span class="sourceLineNo">164</span> * <code>zos</code>.<a name="line.164"></a>
+<span class="sourceLineNo">165</span> *<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are<a name="line.166"></a>
+<span class="sourceLineNo">167</span> * compressing. Generally this is <code>target/site</code>.<a name="line.167"></a>
+<span class="sourceLineNo">168</span> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.<a name="line.168"></a>
+<span class="sourceLineNo">169</span> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.<a name="line.169"></a>
+<span class="sourceLineNo">170</span> * @throws IOException if adding the <code>file</code> doesn't work out properly.<a name="line.170"></a>
+<span class="sourceLineNo">171</span> */<a name="line.171"></a>
+<span class="sourceLineNo">172</span> private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {<a name="line.172"></a>
+<span class="sourceLineNo">173</span> try (InputStream fis = Files.newInputStream(file.toPath())) {<a name="line.173"></a>
+<span class="sourceLineNo">174</span> // we want the zipEntry's path to be a relative path that is relative<a name="line.174"></a>
+<span class="sourceLineNo">175</span> // to the directory being zipped, so chop off the rest of the path<a name="line.175"></a>
+<span class="sourceLineNo">176</span> final String zipFilePath = file.getCanonicalPath().substring(<a name="line.176"></a>
+<span class="sourceLineNo">177</span> directoryToZip.getCanonicalPath().length() + 1,<a name="line.177"></a>
+<span class="sourceLineNo">178</span> file.getCanonicalPath().length());<a name="line.178"></a>
+<span class="sourceLineNo">179</span> final ZipEntry zipEntry = new ZipEntry(zipFilePath);<a name="line.179"></a>
+<span class="sourceLineNo">180</span> zos.putNextEntry(zipEntry);<a name="line.180"></a>
+<span class="sourceLineNo">181</span> IOUtils.copy(fis, zos);<a name="line.181"></a>
+<span class="sourceLineNo">182</span> }<a name="line.182"></a>
+<span class="sourceLineNo">183</span> }<a name="line.183"></a>
+<span class="sourceLineNo">184</span>}<a name="line.184"></a>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html Thu Mar 17 19:32:29 2022
@@ -39,12 +39,12 @@
<span class="sourceLineNo">031</span> * @since 1.3<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class HeaderHtmlVelocityDelegate {<a name="line.33"></a>
-<span class="sourceLineNo">034</span> /** The location of the velocity tempate for this class. */<a name="line.34"></a>
-<span class="sourceLineNo">035</span> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin"<a name="line.35"></a>
-<span class="sourceLineNo">036</span> + "/velocity/HEADER.vm";<a name="line.36"></a>
-<span class="sourceLineNo">037</span> /** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */<a name="line.37"></a>
-<span class="sourceLineNo">038</span> private HeaderHtmlVelocityDelegate() {<a name="line.38"></a>
-<span class="sourceLineNo">039</span> super();<a name="line.39"></a>
+<span class="sourceLineNo">034</span><a name="line.34"></a>
+<span class="sourceLineNo">035</span> /** The location of the velocity tempate for this class. */<a name="line.35"></a>
+<span class="sourceLineNo">036</span> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin/velocity/HEADER.vm";<a name="line.36"></a>
+<span class="sourceLineNo">037</span><a name="line.37"></a>
+<span class="sourceLineNo">038</span> /** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */<a name="line.38"></a>
+<span class="sourceLineNo">039</span> private HeaderHtmlVelocityDelegate() {<a name="line.39"></a>
<span class="sourceLineNo">040</span> }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
@@ -82,18 +82,17 @@
<span class="sourceLineNo">074</span> * Private constructor so that we can have a proper builder pattern.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> private HeaderHtmlVelocityDelegateBuilder() {<a name="line.76"></a>
-<span class="sourceLineNo">077</span> super();<a name="line.77"></a>
-<span class="sourceLineNo">078</span> }<a name="line.78"></a>
-<span class="sourceLineNo">079</span><a name="line.79"></a>
-<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
-<span class="sourceLineNo">081</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.81"></a>
-<span class="sourceLineNo">082</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> */<a name="line.83"></a>
-<span class="sourceLineNo">084</span> public HeaderHtmlVelocityDelegate build() {<a name="line.84"></a>
-<span class="sourceLineNo">085</span> return new HeaderHtmlVelocityDelegate();<a name="line.85"></a>
-<span class="sourceLineNo">086</span> }<a name="line.86"></a>
-<span class="sourceLineNo">087</span> }<a name="line.87"></a>
-<span class="sourceLineNo">088</span>}<a name="line.88"></a>
+<span class="sourceLineNo">077</span> }<a name="line.77"></a>
+<span class="sourceLineNo">078</span><a name="line.78"></a>
+<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.81"></a>
+<span class="sourceLineNo">082</span> */<a name="line.82"></a>
+<span class="sourceLineNo">083</span> public HeaderHtmlVelocityDelegate build() {<a name="line.83"></a>
+<span class="sourceLineNo">084</span> return new HeaderHtmlVelocityDelegate();<a name="line.84"></a>
+<span class="sourceLineNo">085</span> }<a name="line.85"></a>
+<span class="sourceLineNo">086</span> }<a name="line.86"></a>
+<span class="sourceLineNo">087</span>}<a name="line.87"></a>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html Thu Mar 17 19:32:29 2022
@@ -39,12 +39,12 @@
<span class="sourceLineNo">031</span> * @since 1.3<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class HeaderHtmlVelocityDelegate {<a name="line.33"></a>
-<span class="sourceLineNo">034</span> /** The location of the velocity tempate for this class. */<a name="line.34"></a>
-<span class="sourceLineNo">035</span> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin"<a name="line.35"></a>
-<span class="sourceLineNo">036</span> + "/velocity/HEADER.vm";<a name="line.36"></a>
-<span class="sourceLineNo">037</span> /** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */<a name="line.37"></a>
-<span class="sourceLineNo">038</span> private HeaderHtmlVelocityDelegate() {<a name="line.38"></a>
-<span class="sourceLineNo">039</span> super();<a name="line.39"></a>
+<span class="sourceLineNo">034</span><a name="line.34"></a>
+<span class="sourceLineNo">035</span> /** The location of the velocity tempate for this class. */<a name="line.35"></a>
+<span class="sourceLineNo">036</span> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin/velocity/HEADER.vm";<a name="line.36"></a>
+<span class="sourceLineNo">037</span><a name="line.37"></a>
+<span class="sourceLineNo">038</span> /** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */<a name="line.38"></a>
+<span class="sourceLineNo">039</span> private HeaderHtmlVelocityDelegate() {<a name="line.39"></a>
<span class="sourceLineNo">040</span> }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
@@ -82,18 +82,17 @@
<span class="sourceLineNo">074</span> * Private constructor so that we can have a proper builder pattern.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> private HeaderHtmlVelocityDelegateBuilder() {<a name="line.76"></a>
-<span class="sourceLineNo">077</span> super();<a name="line.77"></a>
-<span class="sourceLineNo">078</span> }<a name="line.78"></a>
-<span class="sourceLineNo">079</span><a name="line.79"></a>
-<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
-<span class="sourceLineNo">081</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.81"></a>
-<span class="sourceLineNo">082</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> */<a name="line.83"></a>
-<span class="sourceLineNo">084</span> public HeaderHtmlVelocityDelegate build() {<a name="line.84"></a>
-<span class="sourceLineNo">085</span> return new HeaderHtmlVelocityDelegate();<a name="line.85"></a>
-<span class="sourceLineNo">086</span> }<a name="line.86"></a>
-<span class="sourceLineNo">087</span> }<a name="line.87"></a>
-<span class="sourceLineNo">088</span>}<a name="line.88"></a>
+<span class="sourceLineNo">077</span> }<a name="line.77"></a>
+<span class="sourceLineNo">078</span><a name="line.78"></a>
+<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.81"></a>
+<span class="sourceLineNo">082</span> */<a name="line.82"></a>
+<span class="sourceLineNo">083</span> public HeaderHtmlVelocityDelegate build() {<a name="line.83"></a>
+<span class="sourceLineNo">084</span> return new HeaderHtmlVelocityDelegate();<a name="line.84"></a>
+<span class="sourceLineNo">085</span> }<a name="line.85"></a>
+<span class="sourceLineNo">086</span> }<a name="line.86"></a>
+<span class="sourceLineNo">087</span>}<a name="line.87"></a>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html Thu Mar 17 19:32:29 2022
@@ -127,48 +127,47 @@
<span class="sourceLineNo">119</span> * method.<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> private ReadmeHtmlVelocityDelegateBuilder() {<a name="line.121"></a>
-<span class="sourceLineNo">122</span> super();<a name="line.122"></a>
-<span class="sourceLineNo">123</span> }<a name="line.123"></a>
-<span class="sourceLineNo">124</span><a name="line.124"></a>
-<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
-<span class="sourceLineNo">126</span> * Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.126"></a>
-<span class="sourceLineNo">127</span> * @param artifactId the {@link String} representing the maven artifactId.<a name="line.127"></a>
-<span class="sourceLineNo">128</span> * @return the builder to continue building.<a name="line.128"></a>
-<span class="sourceLineNo">129</span> */<a name="line.129"></a>
-<span class="sourceLineNo">130</span> public ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {<a name="line.130"></a>
-<span class="sourceLineNo">131</span> this.artifactId = artifactId;<a name="line.131"></a>
-<span class="sourceLineNo">132</span> return this;<a name="line.132"></a>
-<span class="sourceLineNo">133</span> }<a name="line.133"></a>
-<span class="sourceLineNo">134</span><a name="line.134"></a>
-<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * Adds the version to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * @param version the maven version.<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * @return the builder to continue building.<a name="line.138"></a>
-<span class="sourceLineNo">139</span> */<a name="line.139"></a>
-<span class="sourceLineNo">140</span> public ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {<a name="line.140"></a>
-<span class="sourceLineNo">141</span> this.version = version;<a name="line.141"></a>
-<span class="sourceLineNo">142</span> return this;<a name="line.142"></a>
-<span class="sourceLineNo">143</span> }<a name="line.143"></a>
-<span class="sourceLineNo">144</span><a name="line.144"></a>
-<span class="sourceLineNo">145</span> /**<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.146"></a>
-<span class="sourceLineNo">147</span> * @param siteUrl the site url to be used in the <code>README.html</code><a name="line.147"></a>
-<span class="sourceLineNo">148</span> * @return the builder to continue building.<a name="line.148"></a>
-<span class="sourceLineNo">149</span> */<a name="line.149"></a>
-<span class="sourceLineNo">150</span> public ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {<a name="line.150"></a>
-<span class="sourceLineNo">151</span> this.siteUrl = siteUrl;<a name="line.151"></a>
-<span class="sourceLineNo">152</span> return this;<a name="line.152"></a>
-<span class="sourceLineNo">153</span> }<a name="line.153"></a>
-<span class="sourceLineNo">154</span><a name="line.154"></a>
-<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.156"></a>
-<span class="sourceLineNo">157</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.157"></a>
-<span class="sourceLineNo">158</span> */<a name="line.158"></a>
-<span class="sourceLineNo">159</span> public ReadmeHtmlVelocityDelegate build() {<a name="line.159"></a>
-<span class="sourceLineNo">160</span> return new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);<a name="line.160"></a>
-<span class="sourceLineNo">161</span> }<a name="line.161"></a>
-<span class="sourceLineNo">162</span> }<a name="line.162"></a>
-<span class="sourceLineNo">163</span>}<a name="line.163"></a>
+<span class="sourceLineNo">122</span> }<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * @param artifactId the {@link String} representing the maven artifactId.<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * @return the builder to continue building.<a name="line.127"></a>
+<span class="sourceLineNo">128</span> */<a name="line.128"></a>
+<span class="sourceLineNo">129</span> public ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {<a name="line.129"></a>
+<span class="sourceLineNo">130</span> this.artifactId = artifactId;<a name="line.130"></a>
+<span class="sourceLineNo">131</span> return this;<a name="line.131"></a>
+<span class="sourceLineNo">132</span> }<a name="line.132"></a>
+<span class="sourceLineNo">133</span><a name="line.133"></a>
+<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * Adds the version to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * @param version the maven version.<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * @return the builder to continue building.<a name="line.137"></a>
+<span class="sourceLineNo">138</span> */<a name="line.138"></a>
+<span class="sourceLineNo">139</span> public ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {<a name="line.139"></a>
+<span class="sourceLineNo">140</span> this.version = version;<a name="line.140"></a>
+<span class="sourceLineNo">141</span> return this;<a name="line.141"></a>
+<span class="sourceLineNo">142</span> }<a name="line.142"></a>
+<span class="sourceLineNo">143</span><a name="line.143"></a>
+<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @param siteUrl the site url to be used in the <code>README.html</code><a name="line.146"></a>
+<span class="sourceLineNo">147</span> * @return the builder to continue building.<a name="line.147"></a>
+<span class="sourceLineNo">148</span> */<a name="line.148"></a>
+<span class="sourceLineNo">149</span> public ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {<a name="line.149"></a>
+<span class="sourceLineNo">150</span> this.siteUrl = siteUrl;<a name="line.150"></a>
+<span class="sourceLineNo">151</span> return this;<a name="line.151"></a>
+<span class="sourceLineNo">152</span> }<a name="line.152"></a>
+<span class="sourceLineNo">153</span><a name="line.153"></a>
+<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.156"></a>
+<span class="sourceLineNo">157</span> */<a name="line.157"></a>
+<span class="sourceLineNo">158</span> public ReadmeHtmlVelocityDelegate build() {<a name="line.158"></a>
+<span class="sourceLineNo">159</span> return new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);<a name="line.159"></a>
+<span class="sourceLineNo">160</span> }<a name="line.160"></a>
+<span class="sourceLineNo">161</span> }<a name="line.161"></a>
+<span class="sourceLineNo">162</span>}<a name="line.162"></a>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html Thu Mar 17 19:32:29 2022
@@ -127,48 +127,47 @@
<span class="sourceLineNo">119</span> * method.<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> private ReadmeHtmlVelocityDelegateBuilder() {<a name="line.121"></a>
-<span class="sourceLineNo">122</span> super();<a name="line.122"></a>
-<span class="sourceLineNo">123</span> }<a name="line.123"></a>
-<span class="sourceLineNo">124</span><a name="line.124"></a>
-<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
-<span class="sourceLineNo">126</span> * Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.126"></a>
-<span class="sourceLineNo">127</span> * @param artifactId the {@link String} representing the maven artifactId.<a name="line.127"></a>
-<span class="sourceLineNo">128</span> * @return the builder to continue building.<a name="line.128"></a>
-<span class="sourceLineNo">129</span> */<a name="line.129"></a>
-<span class="sourceLineNo">130</span> public ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {<a name="line.130"></a>
-<span class="sourceLineNo">131</span> this.artifactId = artifactId;<a name="line.131"></a>
-<span class="sourceLineNo">132</span> return this;<a name="line.132"></a>
-<span class="sourceLineNo">133</span> }<a name="line.133"></a>
-<span class="sourceLineNo">134</span><a name="line.134"></a>
-<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * Adds the version to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * @param version the maven version.<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * @return the builder to continue building.<a name="line.138"></a>
-<span class="sourceLineNo">139</span> */<a name="line.139"></a>
-<span class="sourceLineNo">140</span> public ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {<a name="line.140"></a>
-<span class="sourceLineNo">141</span> this.version = version;<a name="line.141"></a>
-<span class="sourceLineNo">142</span> return this;<a name="line.142"></a>
-<span class="sourceLineNo">143</span> }<a name="line.143"></a>
-<span class="sourceLineNo">144</span><a name="line.144"></a>
-<span class="sourceLineNo">145</span> /**<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.146"></a>
-<span class="sourceLineNo">147</span> * @param siteUrl the site url to be used in the <code>README.html</code><a name="line.147"></a>
-<span class="sourceLineNo">148</span> * @return the builder to continue building.<a name="line.148"></a>
-<span class="sourceLineNo">149</span> */<a name="line.149"></a>
-<span class="sourceLineNo">150</span> public ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {<a name="line.150"></a>
-<span class="sourceLineNo">151</span> this.siteUrl = siteUrl;<a name="line.151"></a>
-<span class="sourceLineNo">152</span> return this;<a name="line.152"></a>
-<span class="sourceLineNo">153</span> }<a name="line.153"></a>
-<span class="sourceLineNo">154</span><a name="line.154"></a>
-<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.156"></a>
-<span class="sourceLineNo">157</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.157"></a>
-<span class="sourceLineNo">158</span> */<a name="line.158"></a>
-<span class="sourceLineNo">159</span> public ReadmeHtmlVelocityDelegate build() {<a name="line.159"></a>
-<span class="sourceLineNo">160</span> return new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);<a name="line.160"></a>
-<span class="sourceLineNo">161</span> }<a name="line.161"></a>
-<span class="sourceLineNo">162</span> }<a name="line.162"></a>
-<span class="sourceLineNo">163</span>}<a name="line.163"></a>
+<span class="sourceLineNo">122</span> }<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * @param artifactId the {@link String} representing the maven artifactId.<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * @return the builder to continue building.<a name="line.127"></a>
+<span class="sourceLineNo">128</span> */<a name="line.128"></a>
+<span class="sourceLineNo">129</span> public ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {<a name="line.129"></a>
+<span class="sourceLineNo">130</span> this.artifactId = artifactId;<a name="line.130"></a>
+<span class="sourceLineNo">131</span> return this;<a name="line.131"></a>
+<span class="sourceLineNo">132</span> }<a name="line.132"></a>
+<span class="sourceLineNo">133</span><a name="line.133"></a>
+<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * Adds the version to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * @param version the maven version.<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * @return the builder to continue building.<a name="line.137"></a>
+<span class="sourceLineNo">138</span> */<a name="line.138"></a>
+<span class="sourceLineNo">139</span> public ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {<a name="line.139"></a>
+<span class="sourceLineNo">140</span> this.version = version;<a name="line.140"></a>
+<span class="sourceLineNo">141</span> return this;<a name="line.141"></a>
+<span class="sourceLineNo">142</span> }<a name="line.142"></a>
+<span class="sourceLineNo">143</span><a name="line.143"></a>
+<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @param siteUrl the site url to be used in the <code>README.html</code><a name="line.146"></a>
+<span class="sourceLineNo">147</span> * @return the builder to continue building.<a name="line.147"></a>
+<span class="sourceLineNo">148</span> */<a name="line.148"></a>
+<span class="sourceLineNo">149</span> public ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {<a name="line.149"></a>
+<span class="sourceLineNo">150</span> this.siteUrl = siteUrl;<a name="line.150"></a>
+<span class="sourceLineNo">151</span> return this;<a name="line.151"></a>
+<span class="sourceLineNo">152</span> }<a name="line.152"></a>
+<span class="sourceLineNo">153</span><a name="line.153"></a>
+<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * @return a new {@link ReadmeHtmlVelocityDelegate}.<a name="line.156"></a>
+<span class="sourceLineNo">157</span> */<a name="line.157"></a>
+<span class="sourceLineNo">158</span> public ReadmeHtmlVelocityDelegate build() {<a name="line.158"></a>
+<span class="sourceLineNo">159</span> return new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);<a name="line.159"></a>
+<span class="sourceLineNo">160</span> }<a name="line.160"></a>
+<span class="sourceLineNo">161</span> }<a name="line.161"></a>
+<span class="sourceLineNo">162</span>}<a name="line.162"></a>