You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ch...@apache.org on 2019/08/30 13:59:51 UTC

svn commit: r35466 [9/34] - in /dev/commons/commons-release-plugin/1.7-RC1: ./ binaries/ site/ site/apidocs/ site/apidocs/org/ site/apidocs/org/apache/ site/apidocs/org/apache/commons/ site/apidocs/org/apache/commons/release/ site/apidocs/org/apache/co...

Added: dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
==============================================================================
--- dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added)
+++ dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Fri Aug 30 13:59:50 2019
@@ -0,0 +1,560 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<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 org.apache.commons.io.FileUtils;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.commons.lang3.StringUtils;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.commons.release.plugin.SharedFunctions;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.maven.plugin.AbstractMojo;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.maven.plugin.MojoExecutionException;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.maven.plugin.MojoFailureException;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.maven.plugin.logging.Log;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.maven.plugins.annotations.Component;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.maven.plugins.annotations.LifecyclePhase;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.maven.plugins.annotations.Mojo;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.maven.plugins.annotations.Parameter;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.maven.project.MavenProject;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import org.apache.maven.scm.ScmException;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import org.apache.maven.scm.ScmFileSet;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import org.apache.maven.scm.command.add.AddScmResult;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import org.apache.maven.scm.command.checkin.CheckInScmResult;<a name="line.36"></a>
+<span class="sourceLineNo">037</span>import org.apache.maven.scm.command.checkout.CheckOutScmResult;<a name="line.37"></a>
+<span class="sourceLineNo">038</span>import org.apache.maven.scm.manager.BasicScmManager;<a name="line.38"></a>
+<span class="sourceLineNo">039</span>import org.apache.maven.scm.manager.ScmManager;<a name="line.39"></a>
+<span class="sourceLineNo">040</span>import org.apache.maven.scm.provider.ScmProvider;<a name="line.40"></a>
+<span class="sourceLineNo">041</span>import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;<a name="line.41"></a>
+<span class="sourceLineNo">042</span>import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;<a name="line.42"></a>
+<span class="sourceLineNo">043</span>import org.apache.maven.scm.repository.ScmRepository;<a name="line.43"></a>
+<span class="sourceLineNo">044</span>import org.apache.maven.settings.Settings;<a name="line.44"></a>
+<span class="sourceLineNo">045</span>import org.apache.maven.settings.crypto.SettingsDecrypter;<a name="line.45"></a>
+<span class="sourceLineNo">046</span><a name="line.46"></a>
+<span class="sourceLineNo">047</span>import java.io.File;<a name="line.47"></a>
+<span class="sourceLineNo">048</span>import java.io.FileOutputStream;<a name="line.48"></a>
+<span class="sourceLineNo">049</span>import java.io.IOException;<a name="line.49"></a>
+<span class="sourceLineNo">050</span>import java.io.OutputStreamWriter;<a name="line.50"></a>
+<span class="sourceLineNo">051</span>import java.io.Writer;<a name="line.51"></a>
+<span class="sourceLineNo">052</span>import java.util.ArrayList;<a name="line.52"></a>
+<span class="sourceLineNo">053</span>import java.util.Arrays;<a name="line.53"></a>
+<span class="sourceLineNo">054</span>import java.util.List;<a name="line.54"></a>
+<span class="sourceLineNo">055</span><a name="line.55"></a>
+<span class="sourceLineNo">056</span>/**<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * This class checks out the dev distribution location, copies the distributions into that directory<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * structure under the &lt;code&gt;target/commons-release-plugin/scm&lt;/code&gt; directory. Then commits the<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.<a name="line.59"></a>
+<span class="sourceLineNo">060</span> *<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * @author chtompki<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * @since 1.0<a name="line.62"></a>
+<span class="sourceLineNo">063</span> */<a name="line.63"></a>
+<span class="sourceLineNo">064</span>@Mojo(name = "stage-distributions",<a name="line.64"></a>
+<span class="sourceLineNo">065</span>        defaultPhase = LifecyclePhase.DEPLOY,<a name="line.65"></a>
+<span class="sourceLineNo">066</span>        threadSafe = true,<a name="line.66"></a>
+<span class="sourceLineNo">067</span>        aggregator = true)<a name="line.67"></a>
+<span class="sourceLineNo">068</span>public class CommonsDistributionStagingMojo extends AbstractMojo {<a name="line.68"></a>
+<span class="sourceLineNo">069</span><a name="line.69"></a>
+<span class="sourceLineNo">070</span>    /** The name of file generated from the README.vm velocity template to be checked into the dist svn repo. */<a name="line.70"></a>
+<span class="sourceLineNo">071</span>    private static final String README_FILE_NAME = "README.html";<a name="line.71"></a>
+<span class="sourceLineNo">072</span>    /** The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo. */<a name="line.72"></a>
+<span class="sourceLineNo">073</span>    private static final String HEADER_FILE_NAME = "HEADER.html";<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>     * The {@link MavenProject} object is essentially the context of the maven build at<a name="line.76"></a>
+<span class="sourceLineNo">077</span>     * a given time.<a name="line.77"></a>
+<span class="sourceLineNo">078</span>     */<a name="line.78"></a>
+<span class="sourceLineNo">079</span>    @Parameter(defaultValue = "${project}", required = true)<a name="line.79"></a>
+<span class="sourceLineNo">080</span>    private MavenProject project;<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 {@link File} that contains a file to the root directory of the working project. Typically<a name="line.83"></a>
+<span class="sourceLineNo">084</span>     * this directory is where the &lt;code&gt;pom.xml&lt;/code&gt; resides.<a name="line.84"></a>
+<span class="sourceLineNo">085</span>     */<a name="line.85"></a>
+<span class="sourceLineNo">086</span>    @Parameter(defaultValue = "${basedir}")<a name="line.86"></a>
+<span class="sourceLineNo">087</span>    private File baseDir;<a name="line.87"></a>
+<span class="sourceLineNo">088</span><a name="line.88"></a>
+<span class="sourceLineNo">089</span>    /** The location to which the site gets built during running &lt;code&gt;mvn site&lt;/code&gt;. */<a name="line.89"></a>
+<span class="sourceLineNo">090</span>    @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")<a name="line.90"></a>
+<span class="sourceLineNo">091</span>    private File siteDirectory;<a name="line.91"></a>
+<span class="sourceLineNo">092</span><a name="line.92"></a>
+<span class="sourceLineNo">093</span>    /**<a name="line.93"></a>
+<span class="sourceLineNo">094</span>     * The main working directory for the plugin, namely &lt;code&gt;target/commons-release-plugin&lt;/code&gt;, but<a name="line.94"></a>
+<span class="sourceLineNo">095</span>     * that assumes that we're using the default maven &lt;code&gt;${project.build.directory}&lt;/code&gt;.<a name="line.95"></a>
+<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
+<span class="sourceLineNo">097</span>    @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")<a name="line.97"></a>
+<span class="sourceLineNo">098</span>    private File workingDirectory;<a name="line.98"></a>
+<span class="sourceLineNo">099</span><a name="line.99"></a>
+<span class="sourceLineNo">100</span>    /**<a name="line.100"></a>
+<span class="sourceLineNo">101</span>     * The location to which to checkout the dist subversion repository under our working directory, which<a name="line.101"></a>
+<span class="sourceLineNo">102</span>     * was given above.<a name="line.102"></a>
+<span class="sourceLineNo">103</span>     */<a name="line.103"></a>
+<span class="sourceLineNo">104</span>    @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm",<a name="line.104"></a>
+<span class="sourceLineNo">105</span>            property = "commons.distCheckoutDirectory")<a name="line.105"></a>
+<span class="sourceLineNo">106</span>    private File distCheckoutDirectory;<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
+<span class="sourceLineNo">109</span>     * The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.<a name="line.109"></a>
+<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
+<span class="sourceLineNo">111</span>    @Parameter(defaultValue = "${basedir}/RELEASE-NOTES.txt", property = "commons.releaseNotesLocation")<a name="line.111"></a>
+<span class="sourceLineNo">112</span>    private File releaseNotesFile;<a name="line.112"></a>
+<span class="sourceLineNo">113</span><a name="line.113"></a>
+<span class="sourceLineNo">114</span>    /**<a name="line.114"></a>
+<span class="sourceLineNo">115</span>     * A boolean that determines whether or not we actually commit the files up to the subversion repository.<a name="line.115"></a>
+<span class="sourceLineNo">116</span>     * If this is set to &lt;code&gt;true&lt;/code&gt;, we do all but make the commits. We do checkout the repository in question<a name="line.116"></a>
+<span class="sourceLineNo">117</span>     * though.<a name="line.117"></a>
+<span class="sourceLineNo">118</span>     */<a name="line.118"></a>
+<span class="sourceLineNo">119</span>    @Parameter(property = "commons.release.dryRun", defaultValue = "false")<a name="line.119"></a>
+<span class="sourceLineNo">120</span>    private Boolean dryRun;<a name="line.120"></a>
+<span class="sourceLineNo">121</span><a name="line.121"></a>
+<span class="sourceLineNo">122</span>    /**<a name="line.122"></a>
+<span class="sourceLineNo">123</span>     * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to<a name="line.123"></a>
+<span class="sourceLineNo">124</span>     * be of the form: &lt;code&gt;scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#&lt;/code&gt;. Note. that<a name="line.124"></a>
+<span class="sourceLineNo">125</span>     * the prefix to the substring &lt;code&gt;https&lt;/code&gt; is a requirement.<a name="line.125"></a>
+<span class="sourceLineNo">126</span>     */<a name="line.126"></a>
+<span class="sourceLineNo">127</span>    @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")<a name="line.127"></a>
+<span class="sourceLineNo">128</span>    private String distSvnStagingUrl;<a name="line.128"></a>
+<span class="sourceLineNo">129</span><a name="line.129"></a>
+<span class="sourceLineNo">130</span>    /**<a name="line.130"></a>
+<span class="sourceLineNo">131</span>     * A parameter to generally avoid running unless it is specifically turned on by the consuming module.<a name="line.131"></a>
+<span class="sourceLineNo">132</span>     */<a name="line.132"></a>
+<span class="sourceLineNo">133</span>    @Parameter(defaultValue = "false", property = "commons.release.isDistModule")<a name="line.133"></a>
+<span class="sourceLineNo">134</span>    private Boolean isDistModule;<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>     * The release version of the artifact to be built.<a name="line.137"></a>
+<span class="sourceLineNo">138</span>     */<a name="line.138"></a>
+<span class="sourceLineNo">139</span>    @Parameter(property = "commons.release.version")<a name="line.139"></a>
+<span class="sourceLineNo">140</span>    private String commonsReleaseVersion;<a name="line.140"></a>
+<span class="sourceLineNo">141</span><a name="line.141"></a>
+<span class="sourceLineNo">142</span>    /**<a name="line.142"></a>
+<span class="sourceLineNo">143</span>     * The RC version of the release. For example the first voted on candidate would be "RC1".<a name="line.143"></a>
+<span class="sourceLineNo">144</span>     */<a name="line.144"></a>
+<span class="sourceLineNo">145</span>    @Parameter(property = "commons.rc.version")<a name="line.145"></a>
+<span class="sourceLineNo">146</span>    private String commonsRcVersion;<a name="line.146"></a>
+<span class="sourceLineNo">147</span><a name="line.147"></a>
+<span class="sourceLineNo">148</span>    /**<a name="line.148"></a>
+<span class="sourceLineNo">149</span>     * The ID of the server (specified in settings.xml) which should be used for dist authentication.<a name="line.149"></a>
+<span class="sourceLineNo">150</span>     * This will be used in preference to {@link #username}/{@link #password}.<a name="line.150"></a>
+<span class="sourceLineNo">151</span>     */<a name="line.151"></a>
+<span class="sourceLineNo">152</span>    @Parameter(property = "commons.distServer")<a name="line.152"></a>
+<span class="sourceLineNo">153</span>    private String distServer;<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>     * The username for the distribution subversion repository. This is typically your Apache id.<a name="line.156"></a>
+<span class="sourceLineNo">157</span>     */<a name="line.157"></a>
+<span class="sourceLineNo">158</span>    @Parameter(property = "user.name")<a name="line.158"></a>
+<span class="sourceLineNo">159</span>    private String username;<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>     * The password associated with {@link CommonsDistributionStagingMojo#username}.<a name="line.162"></a>
+<span class="sourceLineNo">163</span>     */<a name="line.163"></a>
+<span class="sourceLineNo">164</span>    @Parameter(property = "user.password")<a name="line.164"></a>
+<span class="sourceLineNo">165</span>    private String password;<a name="line.165"></a>
+<span class="sourceLineNo">166</span><a name="line.166"></a>
+<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
+<span class="sourceLineNo">168</span>     * Maven {@link Settings}.<a name="line.168"></a>
+<span class="sourceLineNo">169</span>     */<a name="line.169"></a>
+<span class="sourceLineNo">170</span>    @Parameter(defaultValue = "${settings}", readonly = true, required = true)<a name="line.170"></a>
+<span class="sourceLineNo">171</span>    private Settings settings;<a name="line.171"></a>
+<span class="sourceLineNo">172</span><a name="line.172"></a>
+<span class="sourceLineNo">173</span>    /**<a name="line.173"></a>
+<span class="sourceLineNo">174</span>     * Maven {@link SettingsDecrypter} component.<a name="line.174"></a>
+<span class="sourceLineNo">175</span>     */<a name="line.175"></a>
+<span class="sourceLineNo">176</span>    @Component<a name="line.176"></a>
+<span class="sourceLineNo">177</span>    private SettingsDecrypter settingsDecrypter;<a name="line.177"></a>
+<span class="sourceLineNo">178</span><a name="line.178"></a>
+<span class="sourceLineNo">179</span>    /**<a name="line.179"></a>
+<span class="sourceLineNo">180</span>     * A subdirectory of the dist directory into which we are going to stage the release candidate. We<a name="line.180"></a>
+<span class="sourceLineNo">181</span>     * build this up in the {@link CommonsDistributionStagingMojo#execute()} method. And, for example,<a name="line.181"></a>
+<span class="sourceLineNo">182</span>     * the directory should look like &lt;code&gt;https://https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1&lt;/code&gt;.<a name="line.182"></a>
+<span class="sourceLineNo">183</span>     */<a name="line.183"></a>
+<span class="sourceLineNo">184</span>    private File distVersionRcVersionDirectory;<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span>    @Override<a name="line.186"></a>
+<span class="sourceLineNo">187</span>    public void execute() throws MojoExecutionException, MojoFailureException {<a name="line.187"></a>
+<span class="sourceLineNo">188</span>        if (!isDistModule) {<a name="line.188"></a>
+<span class="sourceLineNo">189</span>            getLog().info("This module is marked as a non distribution "<a name="line.189"></a>
+<span class="sourceLineNo">190</span>                    + "or assembly module, and the plugin will not run.");<a name="line.190"></a>
+<span class="sourceLineNo">191</span>            return;<a name="line.191"></a>
+<span class="sourceLineNo">192</span>        }<a name="line.192"></a>
+<span class="sourceLineNo">193</span>        if (StringUtils.isEmpty(distSvnStagingUrl)) {<a name="line.193"></a>
+<span class="sourceLineNo">194</span>            getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");<a name="line.194"></a>
+<span class="sourceLineNo">195</span>            return;<a name="line.195"></a>
+<span class="sourceLineNo">196</span>        }<a name="line.196"></a>
+<span class="sourceLineNo">197</span>        if (!workingDirectory.exists()) {<a name="line.197"></a>
+<span class="sourceLineNo">198</span>            getLog().info("Current project contains no distributions. Not executing.");<a name="line.198"></a>
+<span class="sourceLineNo">199</span>            return;<a name="line.199"></a>
+<span class="sourceLineNo">200</span>        }<a name="line.200"></a>
+<span class="sourceLineNo">201</span>        getLog().info("Preparing to stage distributions");<a name="line.201"></a>
+<span class="sourceLineNo">202</span>        try {<a name="line.202"></a>
+<span class="sourceLineNo">203</span>            final ScmManager scmManager = new BasicScmManager();<a name="line.203"></a>
+<span class="sourceLineNo">204</span>            scmManager.setScmProvider("svn", new SvnExeScmProvider());<a name="line.204"></a>
+<span class="sourceLineNo">205</span>            final ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);<a name="line.205"></a>
+<span class="sourceLineNo">206</span>            final ScmProvider provider = scmManager.getProviderByRepository(repository);<a name="line.206"></a>
+<span class="sourceLineNo">207</span>            final SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository<a name="line.207"></a>
+<span class="sourceLineNo">208</span>                    .getProviderRepository();<a name="line.208"></a>
+<span class="sourceLineNo">209</span>            SharedFunctions.setAuthentication(<a name="line.209"></a>
+<span class="sourceLineNo">210</span>                    providerRepository,<a name="line.210"></a>
+<span class="sourceLineNo">211</span>                    distServer,<a name="line.211"></a>
+<span class="sourceLineNo">212</span>                    settings,<a name="line.212"></a>
+<span class="sourceLineNo">213</span>                    settingsDecrypter,<a name="line.213"></a>
+<span class="sourceLineNo">214</span>                    username,<a name="line.214"></a>
+<span class="sourceLineNo">215</span>                    password<a name="line.215"></a>
+<span class="sourceLineNo">216</span>            );<a name="line.216"></a>
+<span class="sourceLineNo">217</span>            distVersionRcVersionDirectory =<a name="line.217"></a>
+<span class="sourceLineNo">218</span>                    new File(distCheckoutDirectory, commonsReleaseVersion + "-" + commonsRcVersion);<a name="line.218"></a>
+<span class="sourceLineNo">219</span>            if (!distCheckoutDirectory.exists()) {<a name="line.219"></a>
+<span class="sourceLineNo">220</span>                SharedFunctions.initDirectory(getLog(), distCheckoutDirectory);<a name="line.220"></a>
+<span class="sourceLineNo">221</span>            }<a name="line.221"></a>
+<span class="sourceLineNo">222</span>            final ScmFileSet scmFileSet = new ScmFileSet(distCheckoutDirectory);<a name="line.222"></a>
+<span class="sourceLineNo">223</span>            getLog().info("Checking out dist from: " + distSvnStagingUrl);<a name="line.223"></a>
+<span class="sourceLineNo">224</span>            final CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet);<a name="line.224"></a>
+<span class="sourceLineNo">225</span>            if (!checkOutResult.isSuccess()) {<a name="line.225"></a>
+<span class="sourceLineNo">226</span>                throw new MojoExecutionException("Failed to checkout files from SCM: "<a name="line.226"></a>
+<span class="sourceLineNo">227</span>                        + checkOutResult.getProviderMessage() + " [" + checkOutResult.getCommandOutput() + "]");<a name="line.227"></a>
+<span class="sourceLineNo">228</span>            }<a name="line.228"></a>
+<span class="sourceLineNo">229</span>            final File copiedReleaseNotes = copyReleaseNotesToWorkingDirectory();<a name="line.229"></a>
+<span class="sourceLineNo">230</span>            copyDistributionsIntoScmDirectoryStructureAndAddToSvn(copiedReleaseNotes,<a name="line.230"></a>
+<span class="sourceLineNo">231</span>                    provider, repository);<a name="line.231"></a>
+<span class="sourceLineNo">232</span>            final List&lt;File&gt; filesToAdd = new ArrayList&lt;&gt;();<a name="line.232"></a>
+<span class="sourceLineNo">233</span>            listNotHiddenFilesAndDirectories(distCheckoutDirectory, filesToAdd);<a name="line.233"></a>
+<span class="sourceLineNo">234</span>            if (!dryRun) {<a name="line.234"></a>
+<span class="sourceLineNo">235</span>                final ScmFileSet fileSet = new ScmFileSet(distCheckoutDirectory, filesToAdd);<a name="line.235"></a>
+<span class="sourceLineNo">236</span>                final AddScmResult addResult = provider.add(<a name="line.236"></a>
+<span class="sourceLineNo">237</span>                        repository,<a name="line.237"></a>
+<span class="sourceLineNo">238</span>                        fileSet<a name="line.238"></a>
+<span class="sourceLineNo">239</span>                );<a name="line.239"></a>
+<span class="sourceLineNo">240</span>                if (!addResult.isSuccess()) {<a name="line.240"></a>
+<span class="sourceLineNo">241</span>                    throw new MojoExecutionException("Failed to add files to SCM: " + addResult.getProviderMessage()<a name="line.241"></a>
+<span class="sourceLineNo">242</span>                            + " [" + addResult.getCommandOutput() + "]");<a name="line.242"></a>
+<span class="sourceLineNo">243</span>                }<a name="line.243"></a>
+<span class="sourceLineNo">244</span>                getLog().info("Staging release: " + project.getArtifactId() + ", version: " + project.getVersion());<a name="line.244"></a>
+<span class="sourceLineNo">245</span>                final CheckInScmResult checkInResult = provider.checkIn(<a name="line.245"></a>
+<span class="sourceLineNo">246</span>                        repository,<a name="line.246"></a>
+<span class="sourceLineNo">247</span>                        fileSet,<a name="line.247"></a>
+<span class="sourceLineNo">248</span>                        "Staging release: " + project.getArtifactId() + ", version: " + project.getVersion()<a name="line.248"></a>
+<span class="sourceLineNo">249</span>                );<a name="line.249"></a>
+<span class="sourceLineNo">250</span>                if (!checkInResult.isSuccess()) {<a name="line.250"></a>
+<span class="sourceLineNo">251</span>                    getLog().error("Committing dist files failed: " + checkInResult.getCommandOutput());<a name="line.251"></a>
+<span class="sourceLineNo">252</span>                    throw new MojoExecutionException(<a name="line.252"></a>
+<span class="sourceLineNo">253</span>                            "Committing dist files failed: " + checkInResult.getCommandOutput()<a name="line.253"></a>
+<span class="sourceLineNo">254</span>                    );<a name="line.254"></a>
+<span class="sourceLineNo">255</span>                }<a name="line.255"></a>
+<span class="sourceLineNo">256</span>                getLog().info("Committed revision " + checkInResult.getScmRevision());<a name="line.256"></a>
+<span class="sourceLineNo">257</span>            } else {<a name="line.257"></a>
+<span class="sourceLineNo">258</span>                getLog().info("[Dry run] Would have committed to: " + distSvnStagingUrl);<a name="line.258"></a>
+<span class="sourceLineNo">259</span>                getLog().info(<a name="line.259"></a>
+<span class="sourceLineNo">260</span>                        "[Dry run] Staging release: " + project.getArtifactId() + ", version: " + project.getVersion());<a name="line.260"></a>
+<span class="sourceLineNo">261</span>            }<a name="line.261"></a>
+<span class="sourceLineNo">262</span>        } catch (final ScmException e) {<a name="line.262"></a>
+<span class="sourceLineNo">263</span>            getLog().error("Could not commit files to dist: " + distSvnStagingUrl, e);<a name="line.263"></a>
+<span class="sourceLineNo">264</span>            throw new MojoExecutionException("Could not commit files to dist: " + distSvnStagingUrl, e);<a name="line.264"></a>
+<span class="sourceLineNo">265</span>        }<a name="line.265"></a>
+<span class="sourceLineNo">266</span>    }<a name="line.266"></a>
+<span class="sourceLineNo">267</span><a name="line.267"></a>
+<span class="sourceLineNo">268</span>    /**<a name="line.268"></a>
+<span class="sourceLineNo">269</span>     * Lists all directories and files to a flat list.<a name="line.269"></a>
+<span class="sourceLineNo">270</span>     * @param directory {@link File} containing directory to list<a name="line.270"></a>
+<span class="sourceLineNo">271</span>     * @param files a {@link List} of {@link File} to which to append the files.<a name="line.271"></a>
+<span class="sourceLineNo">272</span>     */<a name="line.272"></a>
+<span class="sourceLineNo">273</span>    private void listNotHiddenFilesAndDirectories(final File directory, final List&lt;File&gt; files) {<a name="line.273"></a>
+<span class="sourceLineNo">274</span>        // Get all the files and directories from a directory.<a name="line.274"></a>
+<span class="sourceLineNo">275</span>        final File[] fList = directory.listFiles();<a name="line.275"></a>
+<span class="sourceLineNo">276</span>        for (final File file : fList) {<a name="line.276"></a>
+<span class="sourceLineNo">277</span>            if (file.isFile() &amp;&amp; !file.isHidden()) {<a name="line.277"></a>
+<span class="sourceLineNo">278</span>                files.add(file);<a name="line.278"></a>
+<span class="sourceLineNo">279</span>            } else if (file.isDirectory() &amp;&amp; !file.isHidden()) {<a name="line.279"></a>
+<span class="sourceLineNo">280</span>                files.add(file);<a name="line.280"></a>
+<span class="sourceLineNo">281</span>                listNotHiddenFilesAndDirectories(file, files);<a name="line.281"></a>
+<span class="sourceLineNo">282</span>            }<a name="line.282"></a>
+<span class="sourceLineNo">283</span>        }<a name="line.283"></a>
+<span class="sourceLineNo">284</span>    }<a name="line.284"></a>
+<span class="sourceLineNo">285</span><a name="line.285"></a>
+<span class="sourceLineNo">286</span>    /**<a name="line.286"></a>
+<span class="sourceLineNo">287</span>     * A utility method that takes the &lt;code&gt;RELEASE-NOTES.txt&lt;/code&gt; file from the base directory of the<a name="line.287"></a>
+<span class="sourceLineNo">288</span>     * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.<a name="line.288"></a>
+<span class="sourceLineNo">289</span>     *<a name="line.289"></a>
+<span class="sourceLineNo">290</span>     * @return the RELEASE-NOTES.txt file that exists in the &lt;code&gt;target/commons-release-notes/scm&lt;/code&gt;<a name="line.290"></a>
+<span class="sourceLineNo">291</span>     *         directory for the purpose of adding it to the scm change set in the method<a name="line.291"></a>
+<span class="sourceLineNo">292</span>     *         {@link CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,<a name="line.292"></a>
+<span class="sourceLineNo">293</span>     *         ScmProvider, ScmRepository)}.<a name="line.293"></a>
+<span class="sourceLineNo">294</span>     * @throws MojoExecutionException if an {@link IOException} occurs as a wrapper so that maven<a name="line.294"></a>
+<span class="sourceLineNo">295</span>     *                                can properly handle the exception.<a name="line.295"></a>
+<span class="sourceLineNo">296</span>     */<a name="line.296"></a>
+<span class="sourceLineNo">297</span>    private File copyReleaseNotesToWorkingDirectory() throws MojoExecutionException {<a name="line.297"></a>
+<span class="sourceLineNo">298</span>        SharedFunctions.initDirectory(getLog(), distVersionRcVersionDirectory);<a name="line.298"></a>
+<span class="sourceLineNo">299</span>        getLog().info("Copying RELEASE-NOTES.txt to working directory.");<a name="line.299"></a>
+<span class="sourceLineNo">300</span>        final File copiedReleaseNotes = new File(distVersionRcVersionDirectory, releaseNotesFile.getName());<a name="line.300"></a>
+<span class="sourceLineNo">301</span>        SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes);<a name="line.301"></a>
+<span class="sourceLineNo">302</span>        return copiedReleaseNotes;<a name="line.302"></a>
+<span class="sourceLineNo">303</span>    }<a name="line.303"></a>
+<span class="sourceLineNo">304</span><a name="line.304"></a>
+<span class="sourceLineNo">305</span>    /**<a name="line.305"></a>
+<span class="sourceLineNo">306</span>     * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into<a name="line.306"></a>
+<span class="sourceLineNo">307</span>     * the directory structure of the distribution staging repository. Specifically:<a name="line.307"></a>
+<span class="sourceLineNo">308</span>     * &lt;ul&gt;<a name="line.308"></a>
+<span class="sourceLineNo">309</span>     *   &lt;li&gt;root:<a name="line.309"></a>
+<span class="sourceLineNo">310</span>     *     &lt;ul&gt;<a name="line.310"></a>
+<span class="sourceLineNo">311</span>     *         &lt;li&gt;site&lt;/li&gt;<a name="line.311"></a>
+<span class="sourceLineNo">312</span>     *         &lt;li&gt;site.zip&lt;/li&gt;<a name="line.312"></a>
+<span class="sourceLineNo">313</span>     *         &lt;li&gt;RELEASE-NOTES.txt&lt;/li&gt;<a name="line.313"></a>
+<span class="sourceLineNo">314</span>     *         &lt;li&gt;source:<a name="line.314"></a>
+<span class="sourceLineNo">315</span>     *           &lt;ul&gt;<a name="line.315"></a>
+<span class="sourceLineNo">316</span>     *             &lt;li&gt;-src artifacts....&lt;/li&gt;<a name="line.316"></a>
+<span class="sourceLineNo">317</span>     *           &lt;/ul&gt;<a name="line.317"></a>
+<span class="sourceLineNo">318</span>     *         &lt;/li&gt;<a name="line.318"></a>
+<span class="sourceLineNo">319</span>     *         &lt;li&gt;binaries:<a name="line.319"></a>
+<span class="sourceLineNo">320</span>     *           &lt;ul&gt;<a name="line.320"></a>
+<span class="sourceLineNo">321</span>     *             &lt;li&gt;-bin artifacts....&lt;/li&gt;<a name="line.321"></a>
+<span class="sourceLineNo">322</span>     *           &lt;/ul&gt;<a name="line.322"></a>
+<span class="sourceLineNo">323</span>     *         &lt;/li&gt;<a name="line.323"></a>
+<span class="sourceLineNo">324</span>     *     &lt;/ul&gt;<a name="line.324"></a>
+<span class="sourceLineNo">325</span>     *   &lt;/li&gt;<a name="line.325"></a>
+<span class="sourceLineNo">326</span>     * &lt;/ul&gt;<a name="line.326"></a>
+<span class="sourceLineNo">327</span>     *<a name="line.327"></a>
+<span class="sourceLineNo">328</span>     * @param copiedReleaseNotes is the RELEASE-NOTES.txt file that exists in the<a name="line.328"></a>
+<span class="sourceLineNo">329</span>     *                           &lt;code&gt;target/commons-release-plugin/scm&lt;/code&gt; directory.<a name="line.329"></a>
+<span class="sourceLineNo">330</span>     * @param provider is the {@link ScmProvider} that we will use for adding the files we wish to commit.<a name="line.330"></a>
+<span class="sourceLineNo">331</span>     * @param repository is the {@link ScmRepository} that we will use for adding the files that we wish to commit.<a name="line.331"></a>
+<span class="sourceLineNo">332</span>     * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven<a name="line.332"></a>
+<span class="sourceLineNo">333</span>     *         {@link ScmFileSet}.<a name="line.333"></a>
+<span class="sourceLineNo">334</span>     * @throws MojoExecutionException if an {@link IOException} occurs so that Maven can handle it properly.<a name="line.334"></a>
+<span class="sourceLineNo">335</span>     */<a name="line.335"></a>
+<span class="sourceLineNo">336</span>    private List&lt;File&gt; copyDistributionsIntoScmDirectoryStructureAndAddToSvn(final File copiedReleaseNotes,<a name="line.336"></a>
+<span class="sourceLineNo">337</span>                                                                             final ScmProvider provider,<a name="line.337"></a>
+<span class="sourceLineNo">338</span>                                                                             final ScmRepository repository)<a name="line.338"></a>
+<span class="sourceLineNo">339</span>            throws MojoExecutionException {<a name="line.339"></a>
+<span class="sourceLineNo">340</span>        final List&lt;File&gt; workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles());<a name="line.340"></a>
+<span class="sourceLineNo">341</span>        final List&lt;File&gt; filesForMavenScmFileSet = new ArrayList&lt;&gt;();<a name="line.341"></a>
+<span class="sourceLineNo">342</span>        final File scmBinariesRoot = new File(distVersionRcVersionDirectory, "binaries");<a name="line.342"></a>
+<span class="sourceLineNo">343</span>        final File scmSourceRoot = new File(distVersionRcVersionDirectory, "source");<a name="line.343"></a>
+<span class="sourceLineNo">344</span>        SharedFunctions.initDirectory(getLog(), scmBinariesRoot);<a name="line.344"></a>
+<span class="sourceLineNo">345</span>        SharedFunctions.initDirectory(getLog(), scmSourceRoot);<a name="line.345"></a>
+<span class="sourceLineNo">346</span>        File copy;<a name="line.346"></a>
+<span class="sourceLineNo">347</span>        for (final File file : workingDirectoryFiles) {<a name="line.347"></a>
+<span class="sourceLineNo">348</span>            if (file.getName().contains("src")) {<a name="line.348"></a>
+<span class="sourceLineNo">349</span>                copy = new File(scmSourceRoot,  file.getName());<a name="line.349"></a>
+<span class="sourceLineNo">350</span>                SharedFunctions.copyFile(getLog(), file, copy);<a name="line.350"></a>
+<span class="sourceLineNo">351</span>                filesForMavenScmFileSet.add(file);<a name="line.351"></a>
+<span class="sourceLineNo">352</span>            } else if (file.getName().contains("bin")) {<a name="line.352"></a>
+<span class="sourceLineNo">353</span>                copy = new File(scmBinariesRoot,  file.getName());<a name="line.353"></a>
+<span class="sourceLineNo">354</span>                SharedFunctions.copyFile(getLog(), file, copy);<a name="line.354"></a>
+<span class="sourceLineNo">355</span>                filesForMavenScmFileSet.add(file);<a name="line.355"></a>
+<span class="sourceLineNo">356</span>            } else if (StringUtils.containsAny(file.getName(), "scm", "sha256.properties", "sha512.properties")) {<a name="line.356"></a>
+<span class="sourceLineNo">357</span>                getLog().debug("Not copying scm directory over to the scm directory because it is the scm directory.");<a name="line.357"></a>
+<span class="sourceLineNo">358</span>                //do nothing because we are copying into scm<a name="line.358"></a>
+<span class="sourceLineNo">359</span>            } else {<a name="line.359"></a>
+<span class="sourceLineNo">360</span>                copy = new File(distCheckoutDirectory.getAbsolutePath(),  file.getName());<a name="line.360"></a>
+<span class="sourceLineNo">361</span>                SharedFunctions.copyFile(getLog(), file, copy);<a name="line.361"></a>
+<span class="sourceLineNo">362</span>                filesForMavenScmFileSet.add(file);<a name="line.362"></a>
+<span class="sourceLineNo">363</span>            }<a name="line.363"></a>
+<span class="sourceLineNo">364</span>        }<a name="line.364"></a>
+<span class="sourceLineNo">365</span>        filesForMavenScmFileSet.addAll(buildReadmeAndHeaderHtmlFiles());<a name="line.365"></a>
+<span class="sourceLineNo">366</span>        filesForMavenScmFileSet.addAll(copySiteToScmDirectory());<a name="line.366"></a>
+<span class="sourceLineNo">367</span>        return filesForMavenScmFileSet;<a name="line.367"></a>
+<span class="sourceLineNo">368</span>    }<a name="line.368"></a>
+<span class="sourceLineNo">369</span><a name="line.369"></a>
+<span class="sourceLineNo">370</span>    /**<a name="line.370"></a>
+<span class="sourceLineNo">371</span>     * Copies &lt;code&gt;${basedir}/target/site&lt;/code&gt; to &lt;code&gt;${basedir}/target/commons-release-plugin/scm/site&lt;/code&gt;.<a name="line.371"></a>
+<span class="sourceLineNo">372</span>     *<a name="line.372"></a>
+<span class="sourceLineNo">373</span>     * @return the {@link List} of {@link File}'s contained in<a name="line.373"></a>
+<span class="sourceLineNo">374</span>     *         &lt;code&gt;${basedir}/target/commons-release-plugin/scm/site&lt;/code&gt;, after the copy is complete.<a name="line.374"></a>
+<span class="sourceLineNo">375</span>     * @throws MojoExecutionException if the site copying fails for some reason.<a name="line.375"></a>
+<span class="sourceLineNo">376</span>     */<a name="line.376"></a>
+<span class="sourceLineNo">377</span>    private List&lt;File&gt; copySiteToScmDirectory() throws MojoExecutionException {<a name="line.377"></a>
+<span class="sourceLineNo">378</span>        if (!siteDirectory.exists()) {<a name="line.378"></a>
+<span class="sourceLineNo">379</span>            getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");<a name="line.379"></a>
+<span class="sourceLineNo">380</span>            throw new MojoExecutionException(<a name="line.380"></a>
+<span class="sourceLineNo">381</span>                    "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."<a name="line.381"></a>
+<span class="sourceLineNo">382</span>            );<a name="line.382"></a>
+<span class="sourceLineNo">383</span>        }<a name="line.383"></a>
+<span class="sourceLineNo">384</span>        final File siteInScm = new File(distVersionRcVersionDirectory, "site");<a name="line.384"></a>
+<span class="sourceLineNo">385</span>        try {<a name="line.385"></a>
+<span class="sourceLineNo">386</span>            FileUtils.copyDirectory(siteDirectory, siteInScm);<a name="line.386"></a>
+<span class="sourceLineNo">387</span>        } catch (final IOException e) {<a name="line.387"></a>
+<span class="sourceLineNo">388</span>            throw new MojoExecutionException("Site copying failed", e);<a name="line.388"></a>
+<span class="sourceLineNo">389</span>        }<a name="line.389"></a>
+<span class="sourceLineNo">390</span>        return new ArrayList&lt;&gt;(FileUtils.listFiles(siteInScm, null, true));<a name="line.390"></a>
+<span class="sourceLineNo">391</span>    }<a name="line.391"></a>
+<span class="sourceLineNo">392</span><a name="line.392"></a>
+<span class="sourceLineNo">393</span>    /**<a name="line.393"></a>
+<span class="sourceLineNo">394</span>     * Builds up &lt;code&gt;README.html&lt;/code&gt; and &lt;code&gt;HEADER.html&lt;/code&gt; that reside in following.<a name="line.394"></a>
+<span class="sourceLineNo">395</span>     * &lt;ul&gt;<a name="line.395"></a>
+<span class="sourceLineNo">396</span>     *     &lt;li&gt;distRoot<a name="line.396"></a>
+<span class="sourceLineNo">397</span>     *     &lt;ul&gt;<a name="line.397"></a>
+<span class="sourceLineNo">398</span>     *         &lt;li&gt;binaries/HEADER.html (symlink)&lt;/li&gt;<a name="line.398"></a>
+<span class="sourceLineNo">399</span>     *         &lt;li&gt;binaries/README.html (symlink)&lt;/li&gt;<a name="line.399"></a>
+<span class="sourceLineNo">400</span>     *         &lt;li&gt;source/HEADER.html (symlink)&lt;/li&gt;<a name="line.400"></a>
+<span class="sourceLineNo">401</span>     *         &lt;li&gt;source/README.html (symlink)&lt;/li&gt;<a name="line.401"></a>
+<span class="sourceLineNo">402</span>     *         &lt;li&gt;HEADER.html&lt;/li&gt;<a name="line.402"></a>
+<span class="sourceLineNo">403</span>     *         &lt;li&gt;README.html&lt;/li&gt;<a name="line.403"></a>
+<span class="sourceLineNo">404</span>     *     &lt;/ul&gt;<a name="line.404"></a>
+<span class="sourceLineNo">405</span>     *     &lt;/li&gt;<a name="line.405"></a>
+<span class="sourceLineNo">406</span>     * &lt;/ul&gt;<a name="line.406"></a>
+<span class="sourceLineNo">407</span>     * @return the {@link List} of created files above<a name="line.407"></a>
+<span class="sourceLineNo">408</span>     * @throws MojoExecutionException if an {@link IOException} occurs in the creation of these<a name="line.408"></a>
+<span class="sourceLineNo">409</span>     *                                files fails.<a name="line.409"></a>
+<span class="sourceLineNo">410</span>     */<a name="line.410"></a>
+<span class="sourceLineNo">411</span>    private List&lt;File&gt; buildReadmeAndHeaderHtmlFiles() throws MojoExecutionException {<a name="line.411"></a>
+<span class="sourceLineNo">412</span>        final List&lt;File&gt; headerAndReadmeFiles = new ArrayList&lt;&gt;();<a name="line.412"></a>
+<span class="sourceLineNo">413</span>        final File headerFile = new File(distVersionRcVersionDirectory, HEADER_FILE_NAME);<a name="line.413"></a>
+<span class="sourceLineNo">414</span>        //<a name="line.414"></a>
+<span class="sourceLineNo">415</span>        // HEADER file<a name="line.415"></a>
+<span class="sourceLineNo">416</span>        //<a name="line.416"></a>
+<span class="sourceLineNo">417</span>        try (Writer headerWriter = new OutputStreamWriter(new FileOutputStream(headerFile), "UTF-8")) {<a name="line.417"></a>
+<span class="sourceLineNo">418</span>            HeaderHtmlVelocityDelegate.builder().build().render(headerWriter);<a name="line.418"></a>
+<span class="sourceLineNo">419</span>        } catch (final IOException e) {<a name="line.419"></a>
+<span class="sourceLineNo">420</span>            final String message = "Could not build HEADER html file " + headerFile;<a name="line.420"></a>
+<span class="sourceLineNo">421</span>            getLog().error(message, e);<a name="line.421"></a>
+<span class="sourceLineNo">422</span>            throw new MojoExecutionException(message, e);<a name="line.422"></a>
+<span class="sourceLineNo">423</span>        }<a name="line.423"></a>
+<span class="sourceLineNo">424</span>        headerAndReadmeFiles.add(headerFile);<a name="line.424"></a>
+<span class="sourceLineNo">425</span>        //<a name="line.425"></a>
+<span class="sourceLineNo">426</span>        // README file<a name="line.426"></a>
+<span class="sourceLineNo">427</span>        //<a name="line.427"></a>
+<span class="sourceLineNo">428</span>        final File readmeFile = new File(distVersionRcVersionDirectory, README_FILE_NAME);<a name="line.428"></a>
+<span class="sourceLineNo">429</span>        try (Writer readmeWriter = new OutputStreamWriter(new FileOutputStream(readmeFile), "UTF-8")) {<a name="line.429"></a>
+<span class="sourceLineNo">430</span>            // @formatter:off<a name="line.430"></a>
+<span class="sourceLineNo">431</span>            final ReadmeHtmlVelocityDelegate readmeHtmlVelocityDelegate = ReadmeHtmlVelocityDelegate.builder()<a name="line.431"></a>
+<span class="sourceLineNo">432</span>                    .withArtifactId(project.getArtifactId())<a name="line.432"></a>
+<span class="sourceLineNo">433</span>                    .withVersion(project.getVersion())<a name="line.433"></a>
+<span class="sourceLineNo">434</span>                    .withSiteUrl(project.getUrl())<a name="line.434"></a>
+<span class="sourceLineNo">435</span>                    .build();<a name="line.435"></a>
+<span class="sourceLineNo">436</span>            // @formatter:on<a name="line.436"></a>
+<span class="sourceLineNo">437</span>            readmeHtmlVelocityDelegate.render(readmeWriter);<a name="line.437"></a>
+<span class="sourceLineNo">438</span>        } catch (final IOException e) {<a name="line.438"></a>
+<span class="sourceLineNo">439</span>            final String message = "Could not build README html file " + readmeFile;<a name="line.439"></a>
+<span class="sourceLineNo">440</span>            getLog().error(message, e);<a name="line.440"></a>
+<span class="sourceLineNo">441</span>            throw new MojoExecutionException(message, e);<a name="line.441"></a>
+<span class="sourceLineNo">442</span>        }<a name="line.442"></a>
+<span class="sourceLineNo">443</span>        headerAndReadmeFiles.add(readmeFile);<a name="line.443"></a>
+<span class="sourceLineNo">444</span>        headerAndReadmeFiles.addAll(copyHeaderAndReadmeToSubdirectories(headerFile, readmeFile));<a name="line.444"></a>
+<span class="sourceLineNo">445</span>        return headerAndReadmeFiles;<a name="line.445"></a>
+<span class="sourceLineNo">446</span>    }<a name="line.446"></a>
+<span class="sourceLineNo">447</span><a name="line.447"></a>
+<span class="sourceLineNo">448</span>    /**<a name="line.448"></a>
+<span class="sourceLineNo">449</span>     * Copies &lt;code&gt;README.html&lt;/code&gt; and &lt;code&gt;HEADER.html&lt;/code&gt; to the source and binaries<a name="line.449"></a>
+<span class="sourceLineNo">450</span>     * directories.<a name="line.450"></a>
+<span class="sourceLineNo">451</span>     *<a name="line.451"></a>
+<span class="sourceLineNo">452</span>     * @param headerFile The originally created &lt;code&gt;HEADER.html&lt;/code&gt; file.<a name="line.452"></a>
+<span class="sourceLineNo">453</span>     * @param readmeFile The originally created &lt;code&gt;README.html&lt;/code&gt; file.<a name="line.453"></a>
+<span class="sourceLineNo">454</span>     * @return a {@link List} of created files.<a name="line.454"></a>
+<span class="sourceLineNo">455</span>     * @throws MojoExecutionException if the {@link SharedFunctions#copyFile(Log, File, File)}<a name="line.455"></a>
+<span class="sourceLineNo">456</span>     *                                fails.<a name="line.456"></a>
+<span class="sourceLineNo">457</span>     */<a name="line.457"></a>
+<span class="sourceLineNo">458</span>    private List&lt;File&gt; copyHeaderAndReadmeToSubdirectories(final File headerFile, final File readmeFile)<a name="line.458"></a>
+<span class="sourceLineNo">459</span>            throws MojoExecutionException {<a name="line.459"></a>
+<span class="sourceLineNo">460</span>        final List&lt;File&gt; symbolicLinkFiles = new ArrayList&lt;&gt;();<a name="line.460"></a>
+<span class="sourceLineNo">461</span>        final File sourceRoot = new File(distVersionRcVersionDirectory, "source");<a name="line.461"></a>
+<span class="sourceLineNo">462</span>        final File binariesRoot = new File(distVersionRcVersionDirectory, "binaries");<a name="line.462"></a>
+<span class="sourceLineNo">463</span>        final File sourceHeaderFile = new File(sourceRoot, HEADER_FILE_NAME);<a name="line.463"></a>
+<span class="sourceLineNo">464</span>        final File sourceReadmeFile = new File(sourceRoot, README_FILE_NAME);<a name="line.464"></a>
+<span class="sourceLineNo">465</span>        final File binariesHeaderFile = new File(binariesRoot, HEADER_FILE_NAME);<a name="line.465"></a>
+<span class="sourceLineNo">466</span>        final File binariesReadmeFile = new File(binariesRoot, README_FILE_NAME);<a name="line.466"></a>
+<span class="sourceLineNo">467</span>        SharedFunctions.copyFile(getLog(), headerFile, sourceHeaderFile);<a name="line.467"></a>
+<span class="sourceLineNo">468</span>        symbolicLinkFiles.add(sourceHeaderFile);<a name="line.468"></a>
+<span class="sourceLineNo">469</span>        SharedFunctions.copyFile(getLog(), readmeFile, sourceReadmeFile);<a name="line.469"></a>
+<span class="sourceLineNo">470</span>        symbolicLinkFiles.add(sourceReadmeFile);<a name="line.470"></a>
+<span class="sourceLineNo">471</span>        SharedFunctions.copyFile(getLog(), headerFile, binariesHeaderFile);<a name="line.471"></a>
+<span class="sourceLineNo">472</span>        symbolicLinkFiles.add(binariesHeaderFile);<a name="line.472"></a>
+<span class="sourceLineNo">473</span>        SharedFunctions.copyFile(getLog(), readmeFile, binariesReadmeFile);<a name="line.473"></a>
+<span class="sourceLineNo">474</span>        symbolicLinkFiles.add(binariesReadmeFile);<a name="line.474"></a>
+<span class="sourceLineNo">475</span>        return symbolicLinkFiles;<a name="line.475"></a>
+<span class="sourceLineNo">476</span>    }<a name="line.476"></a>
+<span class="sourceLineNo">477</span><a name="line.477"></a>
+<span class="sourceLineNo">478</span>    /**<a name="line.478"></a>
+<span class="sourceLineNo">479</span>     * This method is the setter for the {@link CommonsDistributionStagingMojo#baseDir} field, specifically<a name="line.479"></a>
+<span class="sourceLineNo">480</span>     * for the usage in the unit tests.<a name="line.480"></a>
+<span class="sourceLineNo">481</span>     *<a name="line.481"></a>
+<span class="sourceLineNo">482</span>     * @param baseDir is the {@link File} to be used as the project's root directory when this mojo<a name="line.482"></a>
+<span class="sourceLineNo">483</span>     *                is invoked.<a name="line.483"></a>
+<span class="sourceLineNo">484</span>     */<a name="line.484"></a>
+<span class="sourceLineNo">485</span>    protected void setBaseDir(final File baseDir) {<a name="line.485"></a>
+<span class="sourceLineNo">486</span>        this.baseDir = baseDir;<a name="line.486"></a>
+<span class="sourceLineNo">487</span>    }<a name="line.487"></a>
+<span class="sourceLineNo">488</span>}<a name="line.488"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>

Added: dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
==============================================================================
--- dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added)
+++ dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Fri Aug 30 13:59:50 2019
@@ -0,0 +1,254 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<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 &lt;code&gt;./target/site&lt;/code&gt; directory and compresses it to<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * &lt;code&gt;./target/commons-release-plugin/site.zip&lt;/code&gt;.<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>     * &lt;code&gt;${project.build.directory}&lt;/code&gt;, this becomes &lt;code&gt;target/commons-release-plugin&lt;/code&gt;.<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>     * &lt;code&gt;scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo&lt;/code&gt;. Note. that the prefix to the<a name="line.69"></a>
+<span class="sourceLineNo">070</span>     * substring &lt;code&gt;https&lt;/code&gt; 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&lt;File&gt; 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&lt;&gt;();<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 &lt;code&gt;target/site&lt;/code&gt; 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 &lt;code&gt;target/site&lt;/code&gt; 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&lt;File&gt; 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 &lt;code&gt;fileList&lt;/code&gt; to a &lt;code&gt;site.zip&lt;/code&gt; file<a name="line.138"></a>
+<span class="sourceLineNo">139</span>     * in the &lt;code&gt;workingDirectory&lt;/code&gt;.<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>     *                       &lt;code&gt;target/site&lt;/code&gt;).<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&lt;File&gt; 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 &lt;code&gt;directoryToZip&lt;/code&gt; we add the &lt;code&gt;file&lt;/code&gt; to the zip archive represented by<a name="line.161"></a>
+<span class="sourceLineNo">162</span>     * &lt;code&gt;zos&lt;/code&gt;.<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 &lt;code&gt;target/site&lt;/code&gt;.<a name="line.165"></a>
+<span class="sourceLineNo">166</span>     * @param file a {@link File} to add to the {@link ZipOutputStream} &lt;code&gt;zos&lt;/code&gt;.<a name="line.166"></a>
+<span class="sourceLineNo">167</span>     * @param zos the {@link ZipOutputStream} to which to add our &lt;code&gt;file&lt;/code&gt;.<a name="line.167"></a>
+<span class="sourceLineNo">168</span>     * @throws IOException if adding the &lt;code&gt;file&lt;/code&gt; 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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>