You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by ch...@apache.org on 2018/03/05 17:50:35 UTC
svn commit: r1026307 [3/11] - 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/CommonsDistributionStagingMojo.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Mon Mar 5 17:50:33 2018
@@ -24,259 +24,287 @@
<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.release.plugin.SharedFunctions;<a name="line.19"></a>
-<span class="sourceLineNo">020</span>import org.apache.maven.plugin.AbstractMojo;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import org.apache.maven.plugin.MojoExecutionException;<a name="line.21"></a>
-<span class="sourceLineNo">022</span>import org.apache.maven.plugin.MojoFailureException;<a name="line.22"></a>
-<span class="sourceLineNo">023</span>import org.apache.maven.plugins.annotations.LifecyclePhase;<a name="line.23"></a>
-<span class="sourceLineNo">024</span>import org.apache.maven.plugins.annotations.Mojo;<a name="line.24"></a>
-<span class="sourceLineNo">025</span>import org.apache.maven.plugins.annotations.Parameter;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.maven.project.MavenProject;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.maven.scm.ScmException;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.maven.scm.ScmFileSet;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.apache.maven.scm.command.add.AddScmResult;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.maven.scm.command.checkin.CheckInScmResult;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.maven.scm.manager.BasicScmManager;<a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.maven.scm.manager.ScmManager;<a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.maven.scm.provider.ScmProvider;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;<a name="line.34"></a>
-<span class="sourceLineNo">035</span>import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;<a name="line.35"></a>
-<span class="sourceLineNo">036</span>import org.apache.maven.scm.repository.ScmRepository;<a name="line.36"></a>
-<span class="sourceLineNo">037</span><a name="line.37"></a>
-<span class="sourceLineNo">038</span>import java.io.File;<a name="line.38"></a>
-<span class="sourceLineNo">039</span>import java.io.IOException;<a name="line.39"></a>
-<span class="sourceLineNo">040</span>import java.util.ArrayList;<a name="line.40"></a>
-<span class="sourceLineNo">041</span>import java.util.Arrays;<a name="line.41"></a>
-<span class="sourceLineNo">042</span>import java.util.List;<a name="line.42"></a>
-<span class="sourceLineNo">043</span><a name="line.43"></a>
-<span class="sourceLineNo">044</span>/**<a name="line.44"></a>
-<span class="sourceLineNo">045</span> * This class checks out the dev distribution location, copies the distributions into that directory<a name="line.45"></a>
-<span class="sourceLineNo">046</span> * structure under the <code>target/commons-release-plugin/scm</code> directory. Then commits the<a name="line.46"></a>
-<span class="sourceLineNo">047</span> * distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.<a name="line.47"></a>
-<span class="sourceLineNo">048</span> *<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * @author chtompki<a name="line.49"></a>
-<span class="sourceLineNo">050</span> * @since 1.0<a name="line.50"></a>
-<span class="sourceLineNo">051</span> */<a name="line.51"></a>
-<span class="sourceLineNo">052</span>@Mojo(name = "stage-distributions", defaultPhase = LifecyclePhase.DEPLOY, threadSafe = true)<a name="line.52"></a>
-<span class="sourceLineNo">053</span>public class CommonsDistributionStagingMojo extends AbstractMojo {<a name="line.53"></a>
-<span class="sourceLineNo">054</span><a name="line.54"></a>
-<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
-<span class="sourceLineNo">056</span> * The {@link MavenProject} object is essentially the context of the maven build at<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * a given time.<a name="line.57"></a>
-<span class="sourceLineNo">058</span> */<a name="line.58"></a>
-<span class="sourceLineNo">059</span> @Parameter(defaultValue = "${project}", required = true)<a name="line.59"></a>
-<span class="sourceLineNo">060</span> private MavenProject project;<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> * The {@link File} that contains a file to the root directory of the working project. Typically<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * this directory is where the <code>pom.xml</code> resides.<a name="line.64"></a>
-<span class="sourceLineNo">065</span> */<a name="line.65"></a>
-<span class="sourceLineNo">066</span> @Parameter(defaultValue = "${basedir}")<a name="line.66"></a>
-<span class="sourceLineNo">067</span> private File basedir;<a name="line.67"></a>
-<span class="sourceLineNo">068</span><a name="line.68"></a>
-<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
-<span class="sourceLineNo">070</span> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but<a name="line.70"></a>
-<span class="sourceLineNo">071</span> * that assumes that we're using the default maven <code>${project.build.directory}</code>.<a name="line.71"></a>
-<span class="sourceLineNo">072</span> */<a name="line.72"></a>
-<span class="sourceLineNo">073</span> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", alias = "outputDirectory")<a name="line.73"></a>
-<span class="sourceLineNo">074</span> private File workingDirectory;<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> * The location to which to checkout the dist subversion repository under our working directory, which<a name="line.77"></a>
-<span class="sourceLineNo">078</span> * was given above.<a name="line.78"></a>
-<span class="sourceLineNo">079</span> */<a name="line.79"></a>
-<span class="sourceLineNo">080</span> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm", alias = "outputDirectory")<a name="line.80"></a>
-<span class="sourceLineNo">081</span> private File distCheckoutDirectory;<a name="line.81"></a>
-<span class="sourceLineNo">082</span><a name="line.82"></a>
-<span class="sourceLineNo">083</span> /**<a name="line.83"></a>
-<span class="sourceLineNo">084</span> * A boolean that determines whether or not we actually commit the files up to the subversion repository.<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * If this is set to <code>true</code>, we do all but make the commits. We do checkout the repository in question<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * though.<a name="line.86"></a>
-<span class="sourceLineNo">087</span> */<a name="line.87"></a>
-<span class="sourceLineNo">088</span> @Parameter(defaultValue = "false")<a name="line.88"></a>
-<span class="sourceLineNo">089</span> private Boolean dryRun;<a name="line.89"></a>
-<span class="sourceLineNo">090</span><a name="line.90"></a>
-<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
-<span class="sourceLineNo">092</span> * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly<a name="line.92"></a>
-<span class="sourceLineNo">093</span> * this would need to be of the form:<a name="line.93"></a>
-<span class="sourceLineNo">094</span> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * substring <code>https</code> is a requirement.<a name="line.95"></a>
-<span class="sourceLineNo">096</span> */<a name="line.96"></a>
-<span class="sourceLineNo">097</span> @Parameter(required = true)<a name="line.97"></a>
-<span class="sourceLineNo">098</span> private String distSvnStagingUrl;<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 username for the distribution subversion repository. This is typically your apache id.<a name="line.101"></a>
-<span class="sourceLineNo">102</span> */<a name="line.102"></a>
-<span class="sourceLineNo">103</span> @Parameter(property = "user.name")<a name="line.103"></a>
-<span class="sourceLineNo">104</span> private String username;<a name="line.104"></a>
-<span class="sourceLineNo">105</span><a name="line.105"></a>
-<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * The password associated with {@link CommonsDistributionStagingMojo#username}.<a name="line.107"></a>
-<span class="sourceLineNo">108</span> */<a name="line.108"></a>
-<span class="sourceLineNo">109</span> @Parameter(property = "user.password")<a name="line.109"></a>
-<span class="sourceLineNo">110</span> private String password;<a name="line.110"></a>
-<span class="sourceLineNo">111</span><a name="line.111"></a>
-<span class="sourceLineNo">112</span> @Override<a name="line.112"></a>
-<span class="sourceLineNo">113</span> public void execute() throws MojoExecutionException, MojoFailureException {<a name="line.113"></a>
-<span class="sourceLineNo">114</span> getLog().info("Preparing to stage distributions");<a name="line.114"></a>
-<span class="sourceLineNo">115</span> try {<a name="line.115"></a>
-<span class="sourceLineNo">116</span> ScmManager scmManager = new BasicScmManager();<a name="line.116"></a>
-<span class="sourceLineNo">117</span> scmManager.setScmProvider("svn", new SvnExeScmProvider());<a name="line.117"></a>
-<span class="sourceLineNo">118</span> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);<a name="line.118"></a>
-<span class="sourceLineNo">119</span> ScmProvider provider = scmManager.getProviderByRepository(repository);<a name="line.119"></a>
-<span class="sourceLineNo">120</span> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository.getProviderRepository();<a name="line.120"></a>
-<span class="sourceLineNo">121</span> providerRepository.setUser(username);<a name="line.121"></a>
-<span class="sourceLineNo">122</span> providerRepository.setPassword(password);<a name="line.122"></a>
-<span class="sourceLineNo">123</span> if (!workingDirectory.exists()) {<a name="line.123"></a>
-<span class="sourceLineNo">124</span> SharedFunctions.initDirectory(getLog(), workingDirectory);<a name="line.124"></a>
-<span class="sourceLineNo">125</span> }<a name="line.125"></a>
-<span class="sourceLineNo">126</span> if (!distCheckoutDirectory.exists()) {<a name="line.126"></a>
-<span class="sourceLineNo">127</span> SharedFunctions.initDirectory(getLog(), distCheckoutDirectory);<a name="line.127"></a>
-<span class="sourceLineNo">128</span> }<a name="line.128"></a>
-<span class="sourceLineNo">129</span> ScmFileSet scmFileSet = new ScmFileSet(distCheckoutDirectory);<a name="line.129"></a>
-<span class="sourceLineNo">130</span> getLog().info("Checking out dist from: " + distSvnStagingUrl);<a name="line.130"></a>
-<span class="sourceLineNo">131</span> provider.checkOut(repository, scmFileSet);<a name="line.131"></a>
-<span class="sourceLineNo">132</span> copyReleaseNotesToWorkingDirectory();<a name="line.132"></a>
-<span class="sourceLineNo">133</span> List<File> filesToCommit = copyDistributionsIntoScmDirectoryStructure();<a name="line.133"></a>
-<span class="sourceLineNo">134</span> ScmFileSet scmFileSetToCommit = new ScmFileSet(distCheckoutDirectory, filesToCommit);<a name="line.134"></a>
-<span class="sourceLineNo">135</span> if (!dryRun) {<a name="line.135"></a>
-<span class="sourceLineNo">136</span> AddScmResult addResult = provider.add(<a name="line.136"></a>
-<span class="sourceLineNo">137</span> repository,<a name="line.137"></a>
-<span class="sourceLineNo">138</span> scmFileSetToCommit,<a name="line.138"></a>
-<span class="sourceLineNo">139</span> "Staging release: " + project.getArtifactId() + ", version: " + project.getVersion()<a name="line.139"></a>
-<span class="sourceLineNo">140</span> );<a name="line.140"></a>
-<span class="sourceLineNo">141</span> if (addResult.isSuccess()) {<a name="line.141"></a>
-<span class="sourceLineNo">142</span> getLog().info("Staging release: " + project.getArtifactId() + ", version: " + project.getVersion());<a name="line.142"></a>
-<span class="sourceLineNo">143</span> CheckInScmResult checkInResult = provider.checkIn(<a name="line.143"></a>
-<span class="sourceLineNo">144</span> repository,<a name="line.144"></a>
-<span class="sourceLineNo">145</span> scmFileSetToCommit,<a name="line.145"></a>
-<span class="sourceLineNo">146</span> "Staging release: " + project.getArtifactId() + ", version: " + project.getVersion()<a name="line.146"></a>
-<span class="sourceLineNo">147</span> );<a name="line.147"></a>
-<span class="sourceLineNo">148</span> if (!checkInResult.isSuccess()) {<a name="line.148"></a>
-<span class="sourceLineNo">149</span> getLog().error("Committing dist files failed: " + checkInResult.getCommandOutput());<a name="line.149"></a>
-<span class="sourceLineNo">150</span> throw new MojoExecutionException(<a name="line.150"></a>
-<span class="sourceLineNo">151</span> "Committing dist files failed: " + checkInResult.getCommandOutput()<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> } else {<a name="line.154"></a>
-<span class="sourceLineNo">155</span> getLog().error("Adding dist files failed: " + addResult.getCommandOutput());<a name="line.155"></a>
-<span class="sourceLineNo">156</span> throw new MojoExecutionException("Adding dist files failed: " + addResult.getCommandOutput());<a name="line.156"></a>
-<span class="sourceLineNo">157</span> }<a name="line.157"></a>
-<span class="sourceLineNo">158</span> } else {<a name="line.158"></a>
-<span class="sourceLineNo">159</span> getLog().info("Would have committed to: " + distSvnStagingUrl);<a name="line.159"></a>
-<span class="sourceLineNo">160</span> getLog().info("Staging release: " + project.getArtifactId() + ", version: " + project.getVersion());<a name="line.160"></a>
-<span class="sourceLineNo">161</span> }<a name="line.161"></a>
-<span class="sourceLineNo">162</span> } catch (ScmException e) {<a name="line.162"></a>
-<span class="sourceLineNo">163</span> getLog().error("Could not commit files to dist: " + distSvnStagingUrl, e);<a name="line.163"></a>
-<span class="sourceLineNo">164</span> throw new MojoExecutionException("Could not commit files to dist: " + distSvnStagingUrl, e);<a name="line.164"></a>
-<span class="sourceLineNo">165</span> }<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> /**<a name="line.168"></a>
-<span class="sourceLineNo">169</span> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the<a name="line.169"></a>
-<span class="sourceLineNo">170</span> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.<a name="line.170"></a>
-<span class="sourceLineNo">171</span> *<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * @throws MojoExecutionException if an {@link IOException} occurrs as a wrapper so that maven<a name="line.172"></a>
-<span class="sourceLineNo">173</span> * can properly handle the exception.<a name="line.173"></a>
-<span class="sourceLineNo">174</span> */<a name="line.174"></a>
-<span class="sourceLineNo">175</span> private void copyReleaseNotesToWorkingDirectory() throws MojoExecutionException {<a name="line.175"></a>
-<span class="sourceLineNo">176</span> StringBuffer copiedReleaseNotesAbsolutePath;<a name="line.176"></a>
-<span class="sourceLineNo">177</span> getLog().info("Copying RELEASE-NOTES.txt to working directory.");<a name="line.177"></a>
-<span class="sourceLineNo">178</span> File releaseNotes = new File(basedir + "/RELEASE-NOTES.txt");<a name="line.178"></a>
-<span class="sourceLineNo">179</span> copiedReleaseNotesAbsolutePath = new StringBuffer(workingDirectory.getAbsolutePath());<a name="line.179"></a>
-<span class="sourceLineNo">180</span> copiedReleaseNotesAbsolutePath.append("/scm/");<a name="line.180"></a>
-<span class="sourceLineNo">181</span> copiedReleaseNotesAbsolutePath.append(releaseNotes.getName());<a name="line.181"></a>
-<span class="sourceLineNo">182</span> File copiedReleaseNotes = new File(copiedReleaseNotesAbsolutePath.toString());<a name="line.182"></a>
-<span class="sourceLineNo">183</span> SharedFunctions.copyFile(getLog(), releaseNotes, copiedReleaseNotes);<a name="line.183"></a>
-<span class="sourceLineNo">184</span> }<a name="line.184"></a>
-<span class="sourceLineNo">185</span><a name="line.185"></a>
-<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
-<span class="sourceLineNo">187</span> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into<a name="line.187"></a>
-<span class="sourceLineNo">188</span> * the directory structure of the distribution staging repository. Specifically:<a name="line.188"></a>
-<span class="sourceLineNo">189</span> * <ul><a name="line.189"></a>
-<span class="sourceLineNo">190</span> * <li>root:</li><a name="line.190"></a>
-<span class="sourceLineNo">191</span> * <li><ul><a name="line.191"></a>
-<span class="sourceLineNo">192</span> * <li>site.zip</li><a name="line.192"></a>
-<span class="sourceLineNo">193</span> * <li>RELEASE-NOTES.txt</li><a name="line.193"></a>
-<span class="sourceLineNo">194</span> * <li>source:</li><a name="line.194"></a>
-<span class="sourceLineNo">195</span> * <li><ul><a name="line.195"></a>
-<span class="sourceLineNo">196</span> * <li>-src artifacts....</li><a name="line.196"></a>
-<span class="sourceLineNo">197</span> * </ul></li><a name="line.197"></a>
-<span class="sourceLineNo">198</span> * <li>binaries:</li><a name="line.198"></a>
-<span class="sourceLineNo">199</span> * <li><ul><a name="line.199"></a>
-<span class="sourceLineNo">200</span> * <li>-bin artifacts....</li><a name="line.200"></a>
-<span class="sourceLineNo">201</span> * </ul></li><a name="line.201"></a>
-<span class="sourceLineNo">202</span> * </ul></li><a name="line.202"></a>
-<span class="sourceLineNo">203</span> * </ul><a name="line.203"></a>
-<span class="sourceLineNo">204</span> *<a name="line.204"></a>
-<span class="sourceLineNo">205</span> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven<a name="line.205"></a>
-<span class="sourceLineNo">206</span> * {@link ScmFileSet}.<a name="line.206"></a>
-<span class="sourceLineNo">207</span> * @throws MojoExecutionException if an {@link IOException} occurrs so that Maven can handle it properly.<a name="line.207"></a>
-<span class="sourceLineNo">208</span> */<a name="line.208"></a>
-<span class="sourceLineNo">209</span> private List<File> copyDistributionsIntoScmDirectoryStructure() throws MojoExecutionException {<a name="line.209"></a>
-<span class="sourceLineNo">210</span> List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles());<a name="line.210"></a>
-<span class="sourceLineNo">211</span> String scmBinariesRoot = buildDistBinariesRoot();<a name="line.211"></a>
-<span class="sourceLineNo">212</span> String scmSourceRoot = buildDistSourceRoot();<a name="line.212"></a>
-<span class="sourceLineNo">213</span> List<File> filesForMavenScmFileSet = new ArrayList<>();<a name="line.213"></a>
-<span class="sourceLineNo">214</span> File copy;<a name="line.214"></a>
-<span class="sourceLineNo">215</span> for (File file : workingDirectoryFiles) {<a name="line.215"></a>
-<span class="sourceLineNo">216</span> if (file.getName().contains("src")) {<a name="line.216"></a>
-<span class="sourceLineNo">217</span> copy = new File(scmSourceRoot + "/" + file.getName());<a name="line.217"></a>
-<span class="sourceLineNo">218</span> SharedFunctions.copyFile(getLog(), file, copy);<a name="line.218"></a>
-<span class="sourceLineNo">219</span> filesForMavenScmFileSet.add(copy);<a name="line.219"></a>
-<span class="sourceLineNo">220</span> } else if (file.getName().contains("bin")) {<a name="line.220"></a>
-<span class="sourceLineNo">221</span> copy = new File(scmBinariesRoot + "/" + file.getName());<a name="line.221"></a>
-<span class="sourceLineNo">222</span> SharedFunctions.copyFile(getLog(), file, copy);<a name="line.222"></a>
-<span class="sourceLineNo">223</span> filesForMavenScmFileSet.add(copy);<a name="line.223"></a>
-<span class="sourceLineNo">224</span> } else if (file.getName().contains("scm")) {<a name="line.224"></a>
-<span class="sourceLineNo">225</span> getLog().debug("Not copying scm directory over to the scm directory because it is the scm directory.");<a name="line.225"></a>
-<span class="sourceLineNo">226</span> //do nothing because we are copying into scm<a name="line.226"></a>
-<span class="sourceLineNo">227</span> } else {<a name="line.227"></a>
-<span class="sourceLineNo">228</span> copy = new File(distCheckoutDirectory.getAbsolutePath() + "/" + file.getName());<a name="line.228"></a>
-<span class="sourceLineNo">229</span> SharedFunctions.copyFile(getLog(), file, copy);<a name="line.229"></a>
-<span class="sourceLineNo">230</span> filesForMavenScmFileSet.add(copy);<a name="line.230"></a>
-<span class="sourceLineNo">231</span> }<a name="line.231"></a>
-<span class="sourceLineNo">232</span> }<a name="line.232"></a>
-<span class="sourceLineNo">233</span> filesForMavenScmFileSet.add(new File(distCheckoutDirectory + "/RELEASE-NOTES.txt"));<a name="line.233"></a>
-<span class="sourceLineNo">234</span> return filesForMavenScmFileSet;<a name="line.234"></a>
-<span class="sourceLineNo">235</span> }<a name="line.235"></a>
-<span class="sourceLineNo">236</span><a name="line.236"></a>
-<span class="sourceLineNo">237</span> /**<a name="line.237"></a>
-<span class="sourceLineNo">238</span> * Build the path for the distribution binaries directory.<a name="line.238"></a>
-<span class="sourceLineNo">239</span> *<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * @return the local absolute path into the checkedout subversion repository that is where<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * the binaries distributions are to be copied.<a name="line.241"></a>
-<span class="sourceLineNo">242</span> */<a name="line.242"></a>
-<span class="sourceLineNo">243</span> private String buildDistBinariesRoot() {<a name="line.243"></a>
-<span class="sourceLineNo">244</span> StringBuffer buffer = new StringBuffer(distCheckoutDirectory.getAbsolutePath());<a name="line.244"></a>
-<span class="sourceLineNo">245</span> buffer.append("/binaries");<a name="line.245"></a>
-<span class="sourceLineNo">246</span> return buffer.toString();<a name="line.246"></a>
-<span class="sourceLineNo">247</span> }<a name="line.247"></a>
-<span class="sourceLineNo">248</span><a name="line.248"></a>
-<span class="sourceLineNo">249</span> /**<a name="line.249"></a>
-<span class="sourceLineNo">250</span> * Build the path for the distribution source directory.<a name="line.250"></a>
-<span class="sourceLineNo">251</span> *<a name="line.251"></a>
-<span class="sourceLineNo">252</span> * @return the local absolute path into the checkedout subversion repository that is where<a name="line.252"></a>
-<span class="sourceLineNo">253</span> * the source distributions are to be copied.<a name="line.253"></a>
-<span class="sourceLineNo">254</span> */<a name="line.254"></a>
-<span class="sourceLineNo">255</span> private String buildDistSourceRoot() {<a name="line.255"></a>
-<span class="sourceLineNo">256</span> StringBuffer buffer = new StringBuffer(distCheckoutDirectory.getAbsolutePath());<a name="line.256"></a>
-<span class="sourceLineNo">257</span> buffer.append("/source");<a name="line.257"></a>
-<span class="sourceLineNo">258</span> return buffer.toString();<a name="line.258"></a>
-<span class="sourceLineNo">259</span> }<a name="line.259"></a>
-<span class="sourceLineNo">260</span><a name="line.260"></a>
-<span class="sourceLineNo">261</span> /**<a name="line.261"></a>
-<span class="sourceLineNo">262</span> * This method is the setter for the {@link CommonsDistributionStagingMojo#basedir} field, specifically<a name="line.262"></a>
-<span class="sourceLineNo">263</span> * for the usage in the unit tests.<a name="line.263"></a>
-<span class="sourceLineNo">264</span> *<a name="line.264"></a>
-<span class="sourceLineNo">265</span> * @param basedir is the {@link File} to be used as the project's root directory when this mojo<a name="line.265"></a>
-<span class="sourceLineNo">266</span> * is invoked.<a name="line.266"></a>
-<span class="sourceLineNo">267</span> */<a name="line.267"></a>
-<span class="sourceLineNo">268</span> protected void setBasedir(File basedir) {<a name="line.268"></a>
-<span class="sourceLineNo">269</span> this.basedir = basedir;<a name="line.269"></a>
-<span class="sourceLineNo">270</span> }<a name="line.270"></a>
-<span class="sourceLineNo">271</span>}<a name="line.271"></a>
+<span class="sourceLineNo">019</span>import org.apache.commons.lang3.StringUtils;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.commons.release.plugin.SharedFunctions;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.maven.plugin.AbstractMojo;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.maven.plugin.MojoExecutionException;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.maven.plugin.MojoFailureException;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.maven.plugins.annotations.LifecyclePhase;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.maven.plugins.annotations.Mojo;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.maven.plugins.annotations.Parameter;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.maven.project.MavenProject;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.maven.scm.ScmException;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.maven.scm.ScmFileSet;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.maven.scm.command.add.AddScmResult;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.maven.scm.command.checkin.CheckInScmResult;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.maven.scm.manager.BasicScmManager;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import org.apache.maven.scm.manager.ScmManager;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import org.apache.maven.scm.provider.ScmProvider;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;<a name="line.36"></a>
+<span class="sourceLineNo">037</span>import org.apache.maven.scm.repository.ScmRepository;<a name="line.37"></a>
+<span class="sourceLineNo">038</span><a name="line.38"></a>
+<span class="sourceLineNo">039</span>import java.io.File;<a name="line.39"></a>
+<span class="sourceLineNo">040</span>import java.io.IOException;<a name="line.40"></a>
+<span class="sourceLineNo">041</span>import java.util.ArrayList;<a name="line.41"></a>
+<span class="sourceLineNo">042</span>import java.util.Arrays;<a name="line.42"></a>
+<span class="sourceLineNo">043</span>import java.util.List;<a name="line.43"></a>
+<span class="sourceLineNo">044</span><a name="line.44"></a>
+<span class="sourceLineNo">045</span>/**<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * This class checks out the dev distribution location, copies the distributions into that directory<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * structure under the <code>target/commons-release-plugin/scm</code> directory. Then commits the<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> *<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * @author chtompki<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * @since 1.0<a name="line.51"></a>
+<span class="sourceLineNo">052</span> */<a name="line.52"></a>
+<span class="sourceLineNo">053</span>@Mojo(name = "stage-distributions",<a name="line.53"></a>
+<span class="sourceLineNo">054</span> defaultPhase = LifecyclePhase.DEPLOY,<a name="line.54"></a>
+<span class="sourceLineNo">055</span> threadSafe = true,<a name="line.55"></a>
+<span class="sourceLineNo">056</span> aggregator = true)<a name="line.56"></a>
+<span class="sourceLineNo">057</span>public class CommonsDistributionStagingMojo extends AbstractMojo {<a name="line.57"></a>
+<span class="sourceLineNo">058</span><a name="line.58"></a>
+<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * The {@link MavenProject} object is essentially the context of the maven build at<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * a given time.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> */<a name="line.62"></a>
+<span class="sourceLineNo">063</span> @Parameter(defaultValue = "${project}", required = true)<a name="line.63"></a>
+<span class="sourceLineNo">064</span> private MavenProject project;<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 {@link File} that contains a file to the root directory of the working project. Typically<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * this directory is where the <code>pom.xml</code> resides.<a name="line.68"></a>
+<span class="sourceLineNo">069</span> */<a name="line.69"></a>
+<span class="sourceLineNo">070</span> @Parameter(defaultValue = "${basedir}")<a name="line.70"></a>
+<span class="sourceLineNo">071</span> private File basedir;<a name="line.71"></a>
+<span class="sourceLineNo">072</span><a name="line.72"></a>
+<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * that assumes that we're using the default maven <code>${project.build.directory}</code>.<a name="line.75"></a>
+<span class="sourceLineNo">076</span> */<a name="line.76"></a>
+<span class="sourceLineNo">077</span> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")<a name="line.77"></a>
+<span class="sourceLineNo">078</span> private File workingDirectory;<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> * The location to which to checkout the dist subversion repository under our working directory, which<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * was given above.<a name="line.82"></a>
+<span class="sourceLineNo">083</span> */<a name="line.83"></a>
+<span class="sourceLineNo">084</span> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm",<a name="line.84"></a>
+<span class="sourceLineNo">085</span> property = "commons.distCheckoutDirectory")<a name="line.85"></a>
+<span class="sourceLineNo">086</span> private File distCheckoutDirectory;<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">089</span> * The location of the RELEASE-NOTES.txt file such that multimodule builds can configure it.<a name="line.89"></a>
+<span class="sourceLineNo">090</span> */<a name="line.90"></a>
+<span class="sourceLineNo">091</span> @Parameter(defaultValue = "${basedir}/RELEASE-NOTES.txt", property = "commons.releaseNotesLocation")<a name="line.91"></a>
+<span class="sourceLineNo">092</span> private File releaseNotesFile;<a name="line.92"></a>
+<span class="sourceLineNo">093</span><a name="line.93"></a>
+<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * A boolean that determines whether or not we actually commit the files up to the subversion repository.<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * If this is set to <code>true</code>, we do all but make the commits. We do checkout the repository in question<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * though.<a name="line.97"></a>
+<span class="sourceLineNo">098</span> */<a name="line.98"></a>
+<span class="sourceLineNo">099</span> @Parameter(property = "commons.release.dryRun", defaultValue = "false")<a name="line.99"></a>
+<span class="sourceLineNo">100</span> private Boolean dryRun;<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> * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * this would need to be of the form:<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * substring <code>https</code> is a requirement.<a name="line.106"></a>
+<span class="sourceLineNo">107</span> */<a name="line.107"></a>
+<span class="sourceLineNo">108</span> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")<a name="line.108"></a>
+<span class="sourceLineNo">109</span> private String distSvnStagingUrl;<a name="line.109"></a>
+<span class="sourceLineNo">110</span><a name="line.110"></a>
+<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.<a name="line.112"></a>
+<span class="sourceLineNo">113</span> */<a name="line.113"></a>
+<span class="sourceLineNo">114</span> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")<a name="line.114"></a>
+<span class="sourceLineNo">115</span> private Boolean isDistModule;<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> * The username for the distribution subversion repository. This is typically your apache id.<a name="line.118"></a>
+<span class="sourceLineNo">119</span> */<a name="line.119"></a>
+<span class="sourceLineNo">120</span> @Parameter(property = "user.name")<a name="line.120"></a>
+<span class="sourceLineNo">121</span> private String username;<a name="line.121"></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> * The password associated with {@link CommonsDistributionStagingMojo#username}.<a name="line.124"></a>
+<span class="sourceLineNo">125</span> */<a name="line.125"></a>
+<span class="sourceLineNo">126</span> @Parameter(property = "user.password")<a name="line.126"></a>
+<span class="sourceLineNo">127</span> private String password;<a name="line.127"></a>
+<span class="sourceLineNo">128</span><a name="line.128"></a>
+<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
+<span class="sourceLineNo">130</span> public void execute() throws MojoExecutionException, MojoFailureException {<a name="line.130"></a>
+<span class="sourceLineNo">131</span> if (!isDistModule) {<a name="line.131"></a>
+<span class="sourceLineNo">132</span> getLog().info("This module is marked as a non distribution " +<a name="line.132"></a>
+<span class="sourceLineNo">133</span> "or assembly module, and the plugin will not run.");<a name="line.133"></a>
+<span class="sourceLineNo">134</span> return;<a name="line.134"></a>
+<span class="sourceLineNo">135</span> }<a name="line.135"></a>
+<span class="sourceLineNo">136</span> if (StringUtils.isEmpty(distSvnStagingUrl)) {<a name="line.136"></a>
+<span class="sourceLineNo">137</span> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");<a name="line.137"></a>
+<span class="sourceLineNo">138</span> return;<a name="line.138"></a>
+<span class="sourceLineNo">139</span> }<a name="line.139"></a>
+<span class="sourceLineNo">140</span> if (!workingDirectory.exists()) {<a name="line.140"></a>
+<span class="sourceLineNo">141</span> getLog().info("Current project contains no distributions. Not executing.");<a name="line.141"></a>
+<span class="sourceLineNo">142</span> return;<a name="line.142"></a>
+<span class="sourceLineNo">143</span> }<a name="line.143"></a>
+<span class="sourceLineNo">144</span> getLog().info("Preparing to stage distributions");<a name="line.144"></a>
+<span class="sourceLineNo">145</span> try {<a name="line.145"></a>
+<span class="sourceLineNo">146</span> ScmManager scmManager = new BasicScmManager();<a name="line.146"></a>
+<span class="sourceLineNo">147</span> scmManager.setScmProvider("svn", new SvnExeScmProvider());<a name="line.147"></a>
+<span class="sourceLineNo">148</span> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);<a name="line.148"></a>
+<span class="sourceLineNo">149</span> ScmProvider provider = scmManager.getProviderByRepository(repository);<a name="line.149"></a>
+<span class="sourceLineNo">150</span> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository.getProviderRepository();<a name="line.150"></a>
+<span class="sourceLineNo">151</span> providerRepository.setUser(username);<a name="line.151"></a>
+<span class="sourceLineNo">152</span> providerRepository.setPassword(password);<a name="line.152"></a>
+<span class="sourceLineNo">153</span> if (!distCheckoutDirectory.exists()) {<a name="line.153"></a>
+<span class="sourceLineNo">154</span> SharedFunctions.initDirectory(getLog(), distCheckoutDirectory);<a name="line.154"></a>
+<span class="sourceLineNo">155</span> }<a name="line.155"></a>
+<span class="sourceLineNo">156</span> ScmFileSet scmFileSet = new ScmFileSet(distCheckoutDirectory);<a name="line.156"></a>
+<span class="sourceLineNo">157</span> getLog().info("Checking out dist from: " + distSvnStagingUrl);<a name="line.157"></a>
+<span class="sourceLineNo">158</span> provider.checkOut(repository, scmFileSet);<a name="line.158"></a>
+<span class="sourceLineNo">159</span> copyReleaseNotesToWorkingDirectory();<a name="line.159"></a>
+<span class="sourceLineNo">160</span> List<File> filesToCommit = copyDistributionsIntoScmDirectoryStructure();<a name="line.160"></a>
+<span class="sourceLineNo">161</span> if (!dryRun) {<a name="line.161"></a>
+<span class="sourceLineNo">162</span> ScmFileSet scmFileSetToCommit = new ScmFileSet(distCheckoutDirectory, filesToCommit);<a name="line.162"></a>
+<span class="sourceLineNo">163</span> AddScmResult addResult = provider.add(<a name="line.163"></a>
+<span class="sourceLineNo">164</span> repository,<a name="line.164"></a>
+<span class="sourceLineNo">165</span> scmFileSetToCommit,<a name="line.165"></a>
+<span class="sourceLineNo">166</span> "Staging release: " + project.getArtifactId() + ", version: " + project.getVersion()<a name="line.166"></a>
+<span class="sourceLineNo">167</span> );<a name="line.167"></a>
+<span class="sourceLineNo">168</span> if (addResult.isSuccess()) {<a name="line.168"></a>
+<span class="sourceLineNo">169</span> getLog().info("Staging release: " + project.getArtifactId() + ", version: " + project.getVersion());<a name="line.169"></a>
+<span class="sourceLineNo">170</span> CheckInScmResult checkInResult = provider.checkIn(<a name="line.170"></a>
+<span class="sourceLineNo">171</span> repository,<a name="line.171"></a>
+<span class="sourceLineNo">172</span> scmFileSetToCommit,<a name="line.172"></a>
+<span class="sourceLineNo">173</span> "Staging release: " + project.getArtifactId() + ", version: " + project.getVersion()<a name="line.173"></a>
+<span class="sourceLineNo">174</span> );<a name="line.174"></a>
+<span class="sourceLineNo">175</span> if (!checkInResult.isSuccess()) {<a name="line.175"></a>
+<span class="sourceLineNo">176</span> getLog().error("Committing dist files failed: " + checkInResult.getCommandOutput());<a name="line.176"></a>
+<span class="sourceLineNo">177</span> throw new MojoExecutionException(<a name="line.177"></a>
+<span class="sourceLineNo">178</span> "Committing dist files failed: " + checkInResult.getCommandOutput()<a name="line.178"></a>
+<span class="sourceLineNo">179</span> );<a name="line.179"></a>
+<span class="sourceLineNo">180</span> }<a name="line.180"></a>
+<span class="sourceLineNo">181</span> } else {<a name="line.181"></a>
+<span class="sourceLineNo">182</span> getLog().error("Adding dist files failed: " + addResult.getCommandOutput());<a name="line.182"></a>
+<span class="sourceLineNo">183</span> throw new MojoExecutionException("Adding dist files failed: " + addResult.getCommandOutput());<a name="line.183"></a>
+<span class="sourceLineNo">184</span> }<a name="line.184"></a>
+<span class="sourceLineNo">185</span> } else {<a name="line.185"></a>
+<span class="sourceLineNo">186</span> getLog().info("Would have committed to: " + distSvnStagingUrl);<a name="line.186"></a>
+<span class="sourceLineNo">187</span> getLog().info("Staging release: " + project.getArtifactId() + ", version: " + project.getVersion());<a name="line.187"></a>
+<span class="sourceLineNo">188</span> }<a name="line.188"></a>
+<span class="sourceLineNo">189</span> } catch (ScmException e) {<a name="line.189"></a>
+<span class="sourceLineNo">190</span> getLog().error("Could not commit files to dist: " + distSvnStagingUrl, e);<a name="line.190"></a>
+<span class="sourceLineNo">191</span> throw new MojoExecutionException("Could not commit files to dist: " + distSvnStagingUrl, e);<a name="line.191"></a>
+<span class="sourceLineNo">192</span> }<a name="line.192"></a>
+<span class="sourceLineNo">193</span> }<a name="line.193"></a>
+<span class="sourceLineNo">194</span><a name="line.194"></a>
+<span class="sourceLineNo">195</span> /**<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.<a name="line.197"></a>
+<span class="sourceLineNo">198</span> *<a name="line.198"></a>
+<span class="sourceLineNo">199</span> * @throws MojoExecutionException if an {@link IOException} occurrs as a wrapper so that maven<a name="line.199"></a>
+<span class="sourceLineNo">200</span> * can properly handle the exception.<a name="line.200"></a>
+<span class="sourceLineNo">201</span> */<a name="line.201"></a>
+<span class="sourceLineNo">202</span> private void copyReleaseNotesToWorkingDirectory() throws MojoExecutionException {<a name="line.202"></a>
+<span class="sourceLineNo">203</span> StringBuffer copiedReleaseNotesAbsolutePath;<a name="line.203"></a>
+<span class="sourceLineNo">204</span> getLog().info("Copying RELEASE-NOTES.txt to working directory.");<a name="line.204"></a>
+<span class="sourceLineNo">205</span> copiedReleaseNotesAbsolutePath = new StringBuffer(workingDirectory.getAbsolutePath());<a name="line.205"></a>
+<span class="sourceLineNo">206</span> copiedReleaseNotesAbsolutePath.append("/scm/");<a name="line.206"></a>
+<span class="sourceLineNo">207</span> copiedReleaseNotesAbsolutePath.append(releaseNotesFile.getName());<a name="line.207"></a>
+<span class="sourceLineNo">208</span> File copiedReleaseNotes = new File(copiedReleaseNotesAbsolutePath.toString());<a name="line.208"></a>
+<span class="sourceLineNo">209</span> SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes);<a name="line.209"></a>
+<span class="sourceLineNo">210</span> }<a name="line.210"></a>
+<span class="sourceLineNo">211</span><a name="line.211"></a>
+<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
+<span class="sourceLineNo">213</span> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into<a name="line.213"></a>
+<span class="sourceLineNo">214</span> * the directory structure of the distribution staging repository. Specifically:<a name="line.214"></a>
+<span class="sourceLineNo">215</span> * <ul><a name="line.215"></a>
+<span class="sourceLineNo">216</span> * <li>root:</li><a name="line.216"></a>
+<span class="sourceLineNo">217</span> * <li><ul><a name="line.217"></a>
+<span class="sourceLineNo">218</span> * <li>site.zip</li><a name="line.218"></a>
+<span class="sourceLineNo">219</span> * <li>RELEASE-NOTES.txt</li><a name="line.219"></a>
+<span class="sourceLineNo">220</span> * <li>source:</li><a name="line.220"></a>
+<span class="sourceLineNo">221</span> * <li><ul><a name="line.221"></a>
+<span class="sourceLineNo">222</span> * <li>-src artifacts....</li><a name="line.222"></a>
+<span class="sourceLineNo">223</span> * </ul></li><a name="line.223"></a>
+<span class="sourceLineNo">224</span> * <li>binaries:</li><a name="line.224"></a>
+<span class="sourceLineNo">225</span> * <li><ul><a name="line.225"></a>
+<span class="sourceLineNo">226</span> * <li>-bin artifacts....</li><a name="line.226"></a>
+<span class="sourceLineNo">227</span> * </ul></li><a name="line.227"></a>
+<span class="sourceLineNo">228</span> * </ul></li><a name="line.228"></a>
+<span class="sourceLineNo">229</span> * </ul><a name="line.229"></a>
+<span class="sourceLineNo">230</span> *<a name="line.230"></a>
+<span class="sourceLineNo">231</span> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven<a name="line.231"></a>
+<span class="sourceLineNo">232</span> * {@link ScmFileSet}.<a name="line.232"></a>
+<span class="sourceLineNo">233</span> * @throws MojoExecutionException if an {@link IOException} occurrs so that Maven can handle it properly.<a name="line.233"></a>
+<span class="sourceLineNo">234</span> */<a name="line.234"></a>
+<span class="sourceLineNo">235</span> private List<File> copyDistributionsIntoScmDirectoryStructure() throws MojoExecutionException {<a name="line.235"></a>
+<span class="sourceLineNo">236</span> List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles());<a name="line.236"></a>
+<span class="sourceLineNo">237</span> String scmBinariesRoot = buildDistBinariesRoot();<a name="line.237"></a>
+<span class="sourceLineNo">238</span> String scmSourceRoot = buildDistSourceRoot();<a name="line.238"></a>
+<span class="sourceLineNo">239</span> SharedFunctions.initDirectory(getLog(), new File(scmBinariesRoot));<a name="line.239"></a>
+<span class="sourceLineNo">240</span> SharedFunctions.initDirectory(getLog(), new File(scmSourceRoot));<a name="line.240"></a>
+<span class="sourceLineNo">241</span> List<File> filesForMavenScmFileSet = new ArrayList<>();<a name="line.241"></a>
+<span class="sourceLineNo">242</span> File copy;<a name="line.242"></a>
+<span class="sourceLineNo">243</span> for (File file : workingDirectoryFiles) {<a name="line.243"></a>
+<span class="sourceLineNo">244</span> if (file.getName().contains("src")) {<a name="line.244"></a>
+<span class="sourceLineNo">245</span> copy = new File(scmSourceRoot + "/" + file.getName());<a name="line.245"></a>
+<span class="sourceLineNo">246</span> SharedFunctions.copyFile(getLog(), file, copy);<a name="line.246"></a>
+<span class="sourceLineNo">247</span> filesForMavenScmFileSet.add(copy);<a name="line.247"></a>
+<span class="sourceLineNo">248</span> } else if (file.getName().contains("bin")) {<a name="line.248"></a>
+<span class="sourceLineNo">249</span> copy = new File(scmBinariesRoot + "/" + file.getName());<a name="line.249"></a>
+<span class="sourceLineNo">250</span> SharedFunctions.copyFile(getLog(), file, copy);<a name="line.250"></a>
+<span class="sourceLineNo">251</span> filesForMavenScmFileSet.add(copy);<a name="line.251"></a>
+<span class="sourceLineNo">252</span> } else if (file.getName().contains("scm")) {<a name="line.252"></a>
+<span class="sourceLineNo">253</span> getLog().debug("Not copying scm directory over to the scm directory because it is the scm directory.");<a name="line.253"></a>
+<span class="sourceLineNo">254</span> //do nothing because we are copying into scm<a name="line.254"></a>
+<span class="sourceLineNo">255</span> } else {<a name="line.255"></a>
+<span class="sourceLineNo">256</span> copy = new File(distCheckoutDirectory.getAbsolutePath() + "/" + file.getName());<a name="line.256"></a>
+<span class="sourceLineNo">257</span> SharedFunctions.copyFile(getLog(), file, copy);<a name="line.257"></a>
+<span class="sourceLineNo">258</span> filesForMavenScmFileSet.add(copy);<a name="line.258"></a>
+<span class="sourceLineNo">259</span> }<a name="line.259"></a>
+<span class="sourceLineNo">260</span> }<a name="line.260"></a>
+<span class="sourceLineNo">261</span> filesForMavenScmFileSet.add(releaseNotesFile);<a name="line.261"></a>
+<span class="sourceLineNo">262</span> return filesForMavenScmFileSet;<a name="line.262"></a>
+<span class="sourceLineNo">263</span> }<a name="line.263"></a>
+<span class="sourceLineNo">264</span><a name="line.264"></a>
+<span class="sourceLineNo">265</span> /**<a name="line.265"></a>
+<span class="sourceLineNo">266</span> * Build the path for the distribution binaries directory.<a name="line.266"></a>
+<span class="sourceLineNo">267</span> *<a name="line.267"></a>
+<span class="sourceLineNo">268</span> * @return the local absolute path into the checkedout subversion repository that is where<a name="line.268"></a>
+<span class="sourceLineNo">269</span> * the binaries distributions are to be copied.<a name="line.269"></a>
+<span class="sourceLineNo">270</span> */<a name="line.270"></a>
+<span class="sourceLineNo">271</span> private String buildDistBinariesRoot() {<a name="line.271"></a>
+<span class="sourceLineNo">272</span> StringBuffer buffer = new StringBuffer(distCheckoutDirectory.getAbsolutePath());<a name="line.272"></a>
+<span class="sourceLineNo">273</span> buffer.append("/binaries");<a name="line.273"></a>
+<span class="sourceLineNo">274</span> return buffer.toString();<a name="line.274"></a>
+<span class="sourceLineNo">275</span> }<a name="line.275"></a>
+<span class="sourceLineNo">276</span><a name="line.276"></a>
+<span class="sourceLineNo">277</span> /**<a name="line.277"></a>
+<span class="sourceLineNo">278</span> * Build the path for the distribution source directory.<a name="line.278"></a>
+<span class="sourceLineNo">279</span> *<a name="line.279"></a>
+<span class="sourceLineNo">280</span> * @return the local absolute path into the checkedout subversion repository that is where<a name="line.280"></a>
+<span class="sourceLineNo">281</span> * the source distributions are to be copied.<a name="line.281"></a>
+<span class="sourceLineNo">282</span> */<a name="line.282"></a>
+<span class="sourceLineNo">283</span> private String buildDistSourceRoot() {<a name="line.283"></a>
+<span class="sourceLineNo">284</span> StringBuffer buffer = new StringBuffer(distCheckoutDirectory.getAbsolutePath());<a name="line.284"></a>
+<span class="sourceLineNo">285</span> buffer.append("/source");<a name="line.285"></a>
+<span class="sourceLineNo">286</span> return buffer.toString();<a name="line.286"></a>
+<span class="sourceLineNo">287</span> }<a name="line.287"></a>
+<span class="sourceLineNo">288</span><a name="line.288"></a>
+<span class="sourceLineNo">289</span> /**<a name="line.289"></a>
+<span class="sourceLineNo">290</span> * This method is the setter for the {@link CommonsDistributionStagingMojo#basedir} field, specifically<a name="line.290"></a>
+<span class="sourceLineNo">291</span> * for the usage in the unit tests.<a name="line.291"></a>
+<span class="sourceLineNo">292</span> *<a name="line.292"></a>
+<span class="sourceLineNo">293</span> * @param basedir is the {@link File} to be used as the project's root directory when this mojo<a name="line.293"></a>
+<span class="sourceLineNo">294</span> * is invoked.<a name="line.294"></a>
+<span class="sourceLineNo">295</span> */<a name="line.295"></a>
+<span class="sourceLineNo">296</span> protected void setBasedir(File basedir) {<a name="line.296"></a>
+<span class="sourceLineNo">297</span> this.basedir = basedir;<a name="line.297"></a>
+<span class="sourceLineNo">298</span> }<a name="line.298"></a>
+<span class="sourceLineNo">299</span>}<a name="line.299"></a>