Modified: websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Mon Sep 2 19:25:02 2019 @@ -14,7 +14,7 @@ <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> @@ -73,7 +73,7 @@ <a class="jxr_linenumber" name="L65" href="#L65">65</a> defaultPhase = LifecyclePhase.DEPLOY, <a class="jxr_linenumber" name="L66" href="#L66">66</a> threadSafe = <strong class="jxr_keyword">true</strong>, <a class="jxr_linenumber" name="L67" href="#L67">67</a> aggregator = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html">CommonsDistributionStagingMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CommonsDistributionStagingMojo" href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#CommonsDistributionStagingMojo">CommonsDistributionStagingMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { <a class="jxr_linenumber" name="L69" href="#L69">69</a> <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/** The name of file generated from the README.vm velocity template to be checked into the dist svn repo. */</em> <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String README_FILE_NAME = <span class="jxr_string">"README.html"</span>; @@ -129,7 +129,7 @@ <a class="jxr_linenumber" name="L121" href="#L121">121</a> <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * be of the form: <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>. Note. that</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * be of the form: <code>scm:svn:<a href="https://dist.apache.org/repos/dist/dev/commons/foo/version-RC" target="alexandria_uri">https://dist.apache.org/repos/dist/dev/commons/foo/version-RC</a>#</code>. Note. that</em> <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * the prefix to the substring <code>https</code> is a requirement.</em> <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L127" href="#L127">127</a> @Parameter(defaultValue = <span class="jxr_string">""</span>, property = <span class="jxr_string">"commons.distSvnStagingUrl"</span>) @@ -187,7 +187,7 @@ <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * A subdirectory of the dist directory into which we are going to stage the release candidate. We</em> <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * build this up in the {@link CommonsDistributionStagingMojo#execute()} method. And, for example,</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * the directory should look like <code>https://https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * the directory should look like <code><a href="https://https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>." target="alexandria_uri">https://https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</a></em> <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">private</strong> File distVersionRcVersionDirectory; <a class="jxr_linenumber" name="L185" href="#L185">185</a> @@ -208,291 +208,292 @@ <a class="jxr_linenumber" name="L200" href="#L200">200</a> } <a class="jxr_linenumber" name="L201" href="#L201">201</a> getLog().info(<span class="jxr_string">"Preparing to stage distributions"</span>); <a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L203" href="#L203">203</a> ScmManager scmManager = <strong class="jxr_keyword">new</strong> BasicScmManager(); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">final</strong> ScmManager scmManager = <strong class="jxr_keyword">new</strong> BasicScmManager(); <a class="jxr_linenumber" name="L204" href="#L204">204</a> scmManager.setScmProvider(<span class="jxr_string">"svn"</span>, <strong class="jxr_keyword">new</strong> SvnExeScmProvider()); -<a class="jxr_linenumber" name="L205" href="#L205">205</a> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> ScmProvider provider = scmManager.getProviderByRepository(repository); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository.getProviderRepository(); -<a class="jxr_linenumber" name="L208" href="#L208">208</a> SharedFunctions.setAuthentication( -<a class="jxr_linenumber" name="L209" href="#L209">209</a> providerRepository, -<a class="jxr_linenumber" name="L210" href="#L210">210</a> distServer, -<a class="jxr_linenumber" name="L211" href="#L211">211</a> settings, -<a class="jxr_linenumber" name="L212" href="#L212">212</a> settingsDecrypter, -<a class="jxr_linenumber" name="L213" href="#L213">213</a> username, -<a class="jxr_linenumber" name="L214" href="#L214">214</a> password -<a class="jxr_linenumber" name="L215" href="#L215">215</a> ); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> distVersionRcVersionDirectory = -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory, commonsReleaseVersion + <span class="jxr_string">"-"</span> + commonsRcVersion); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (!distCheckoutDirectory.exists()) { -<a class="jxr_linenumber" name="L219" href="#L219">219</a> SharedFunctions.initDirectory(getLog(), distCheckoutDirectory); -<a class="jxr_linenumber" name="L220" href="#L220">220</a> } -<a class="jxr_linenumber" name="L221" href="#L221">221</a> ScmFileSet scmFileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory); -<a class="jxr_linenumber" name="L222" href="#L222">222</a> getLog().info(<span class="jxr_string">"Checking out dist from: "</span> + distSvnStagingUrl); -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">final</strong> CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet); -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> (!checkOutResult.isSuccess()) { -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to checkout files from SCM: "</span> -<a class="jxr_linenumber" name="L226" href="#L226">226</a> + checkOutResult.getProviderMessage() + <span class="jxr_string">" ["</span> + checkOutResult.getCommandOutput() + <span class="jxr_string">"]"</span>); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> } -<a class="jxr_linenumber" name="L228" href="#L228">228</a> File copiedReleaseNotes = copyReleaseNotesToWorkingDirectory(); -<a class="jxr_linenumber" name="L229" href="#L229">229</a> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(copiedReleaseNotes, -<a class="jxr_linenumber" name="L230" href="#L230">230</a> provider, repository); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> List<File> filesToAdd = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L232" href="#L232">232</a> listNotHiddenFilesAndDirectories(distCheckoutDirectory, filesToAdd); -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> (!dryRun) { -<a class="jxr_linenumber" name="L234" href="#L234">234</a> ScmFileSet fileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory, filesToAdd); -<a class="jxr_linenumber" name="L235" href="#L235">235</a> AddScmResult addResult = provider.add( -<a class="jxr_linenumber" name="L236" href="#L236">236</a> repository, -<a class="jxr_linenumber" name="L237" href="#L237">237</a> fileSet -<a class="jxr_linenumber" name="L238" href="#L238">238</a> ); -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">if</strong> (!addResult.isSuccess()) { -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to add files to SCM: "</span> + addResult.getProviderMessage() -<a class="jxr_linenumber" name="L241" href="#L241">241</a> + <span class="jxr_string">" ["</span> + addResult.getCommandOutput() + <span class="jxr_string">"]"</span>); -<a class="jxr_linenumber" name="L242" href="#L242">242</a> } -<a class="jxr_linenumber" name="L243" href="#L243">243</a> getLog().info(<span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); -<a class="jxr_linenumber" name="L244" href="#L244">244</a> CheckInScmResult checkInResult = provider.checkIn( -<a class="jxr_linenumber" name="L245" href="#L245">245</a> repository, -<a class="jxr_linenumber" name="L246" href="#L246">246</a> fileSet, -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion() -<a class="jxr_linenumber" name="L248" href="#L248">248</a> ); -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (!checkInResult.isSuccess()) { -<a class="jxr_linenumber" name="L250" href="#L250">250</a> getLog().error(<span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput()); -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput() -<a class="jxr_linenumber" name="L253" href="#L253">253</a> ); -<a class="jxr_linenumber" name="L254" href="#L254">254</a> } -<a class="jxr_linenumber" name="L255" href="#L255">255</a> getLog().info(<span class="jxr_string">"Committed revision "</span> + checkInResult.getScmRevision()); -<a class="jxr_linenumber" name="L256" href="#L256">256</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> getLog().info(<span class="jxr_string">"[Dry run] Would have committed to: "</span> + distSvnStagingUrl); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> getLog().info( -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <span class="jxr_string">"[Dry run] Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); -<a class="jxr_linenumber" name="L260" href="#L260">260</a> } -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) { -<a class="jxr_linenumber" name="L262" href="#L262">262</a> getLog().error(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); -<a class="jxr_linenumber" name="L264" href="#L264">264</a> } -<a class="jxr_linenumber" name="L265" href="#L265">265</a> } -<a class="jxr_linenumber" name="L266" href="#L266">266</a> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * Lists all directories and files to a flat list.</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @param directory {@link File} containing directory to list</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @param files a {@link List} of {@link File} to which to append the files.</em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> listNotHiddenFilesAndDirectories(File directory, List<File> files) { -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_comment">// Get all the files and directories from a directory.</em> -<a class="jxr_linenumber" name="L274" href="#L274">274</a> File[] fList = directory.listFiles(); -<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">for</strong> (File file : fList) { -<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">if</strong> (file.isFile() && !file.isHidden()) { -<a class="jxr_linenumber" name="L277" href="#L277">277</a> files.add(file); -<a class="jxr_linenumber" name="L278" href="#L278">278</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.isDirectory() && !file.isHidden()) { -<a class="jxr_linenumber" name="L279" href="#L279">279</a> files.add(file); -<a class="jxr_linenumber" name="L280" href="#L280">280</a> listNotHiddenFilesAndDirectories(file, files); -<a class="jxr_linenumber" name="L281" href="#L281">281</a> } -<a class="jxr_linenumber" name="L282" href="#L282">282</a> } -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } -<a class="jxr_linenumber" name="L284" href="#L284">284</a> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the</em> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.</em> -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @return the RELEASE-NOTES.txt file that exists in the <code>target/commons-release-notes/scm</code></em> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * directory for the purpose of adding it to the scm change set in the method</em> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * {@link CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,</em> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * ScmProvider, ScmRepository)}.</em> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs as a wrapper so that maven</em> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * can properly handle the exception.</em> -<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">private</strong> File copyReleaseNotesToWorkingDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L297" href="#L297">297</a> SharedFunctions.initDirectory(getLog(), distVersionRcVersionDirectory); -<a class="jxr_linenumber" name="L298" href="#L298">298</a> getLog().info(<span class="jxr_string">"Copying RELEASE-NOTES.txt to working directory."</span>); -<a class="jxr_linenumber" name="L299" href="#L299">299</a> File copiedReleaseNotes = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, releaseNotesFile.getName()); -<a class="jxr_linenumber" name="L300" href="#L300">300</a> SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes); -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">return</strong> copiedReleaseNotes; -<a class="jxr_linenumber" name="L302" href="#L302">302</a> } -<a class="jxr_linenumber" name="L303" href="#L303">303</a> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into</em> -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * the directory structure of the distribution staging repository. Specifically:</em> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * <li>root:</em> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * <li>site</li></em> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * <li>site.zip</li></em> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * <li>RELEASE-NOTES.txt</li></em> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * <li>source:</em> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * <li>-src artifacts....</li></em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * </li></em> -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * <li>binaries:</em> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * <li>-bin artifacts....</li></em> -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * </li></em> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * </li></em> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * @param copiedReleaseNotes is the RELEASE-NOTES.txt file that exists in the</em> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * <code>target/commons-release-plugin/scm</code> directory.</em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * @param provider is the {@link ScmProvider} that we will use for adding the files we wish to commit.</em> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @param repository is the {@link ScmRepository} that we will use for adding the files that we wish to commit.</em> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven</em> -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * {@link ScmFileSet}.</em> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs so that Maven can handle it properly.</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">private</strong> List<File> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File copiedReleaseNotes, -<a class="jxr_linenumber" name="L336" href="#L336">336</a> ScmProvider provider, -<a class="jxr_linenumber" name="L337" href="#L337">337</a> ScmRepository repository) -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L339" href="#L339">339</a> List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles()); -<a class="jxr_linenumber" name="L340" href="#L340">340</a> List<File> filesForMavenScmFileSet = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L341" href="#L341">341</a> File scmBinariesRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"binaries"</span>); -<a class="jxr_linenumber" name="L342" href="#L342">342</a> File scmSourceRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"source"</span>); -<a class="jxr_linenumber" name="L343" href="#L343">343</a> SharedFunctions.initDirectory(getLog(), scmBinariesRoot); -<a class="jxr_linenumber" name="L344" href="#L344">344</a> SharedFunctions.initDirectory(getLog(), scmSourceRoot); -<a class="jxr_linenumber" name="L345" href="#L345">345</a> File copy; -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">for</strong> (File file : workingDirectoryFiles) { -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"src"</span>)) { -<a class="jxr_linenumber" name="L348" href="#L348">348</a> copy = <strong class="jxr_keyword">new</strong> File(scmSourceRoot, file.getName()); -<a class="jxr_linenumber" name="L349" href="#L349">349</a> SharedFunctions.copyFile(getLog(), file, copy); -<a class="jxr_linenumber" name="L350" href="#L350">350</a> filesForMavenScmFileSet.add(file); -<a class="jxr_linenumber" name="L351" href="#L351">351</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"bin"</span>)) { -<a class="jxr_linenumber" name="L352" href="#L352">352</a> copy = <strong class="jxr_keyword">new</strong> File(scmBinariesRoot, file.getName()); -<a class="jxr_linenumber" name="L353" href="#L353">353</a> SharedFunctions.copyFile(getLog(), file, copy); -<a class="jxr_linenumber" name="L354" href="#L354">354</a> filesForMavenScmFileSet.add(file); -<a class="jxr_linenumber" name="L355" href="#L355">355</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (StringUtils.containsAny(file.getName(), <span class="jxr_string">"scm"</span>, <span class="jxr_string">"sha256.properties"</span>, <span class="jxr_string">"sha512.properties"</span>)) { -<a class="jxr_linenumber" name="L356" href="#L356">356</a> getLog().debug(<span class="jxr_string">"Not copying scm directory over to the scm directory because it is the scm directory."</span>); -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_comment">//do nothing because we are copying into scm</em> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L359" href="#L359">359</a> copy = <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory.getAbsolutePath(), file.getName()); -<a class="jxr_linenumber" name="L360" href="#L360">360</a> SharedFunctions.copyFile(getLog(), file, copy); -<a class="jxr_linenumber" name="L361" href="#L361">361</a> filesForMavenScmFileSet.add(file); -<a class="jxr_linenumber" name="L362" href="#L362">362</a> } -<a class="jxr_linenumber" name="L363" href="#L363">363</a> } -<a class="jxr_linenumber" name="L364" href="#L364">364</a> filesForMavenScmFileSet.addAll(buildReadmeAndHeaderHtmlFiles()); -<a class="jxr_linenumber" name="L365" href="#L365">365</a> filesForMavenScmFileSet.addAll(copySiteToScmDirectory()); -<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">return</strong> filesForMavenScmFileSet; -<a class="jxr_linenumber" name="L367" href="#L367">367</a> } -<a class="jxr_linenumber" name="L368" href="#L368">368</a> -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</em> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * @return the {@link List} of {@link File}'s contained in</em> -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * <code>${basedir}/target/commons-release-plugin/scm/site</code>, after the copy is complete.</em> -<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the site copying fails for some reason.</em> -<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">private</strong> List<File> copySiteToScmDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">if</strong> (!siteDirectory.exists()) { -<a class="jxr_linenumber" name="L378" href="#L378">378</a> getLog().error(<span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span>); -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L380" href="#L380">380</a> <span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> -<a class="jxr_linenumber" name="L381" href="#L381">381</a> ); -<a class="jxr_linenumber" name="L382" href="#L382">382</a> } -<a class="jxr_linenumber" name="L383" href="#L383">383</a> File siteInScm = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"site"</span>); -<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L385" href="#L385">385</a> FileUtils.copyDirectory(siteDirectory, siteInScm); -<a class="jxr_linenumber" name="L386" href="#L386">386</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Site copying failed"</span>, e); -<a class="jxr_linenumber" name="L388" href="#L388">388</a> } -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ArrayList<>(FileUtils.listFiles(siteInScm, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">true</strong>)); -<a class="jxr_linenumber" name="L390" href="#L390">390</a> } -<a class="jxr_linenumber" name="L391" href="#L391">391</a> -<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</em> -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * <li>distRoot</em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * <li>binaries/HEADER.html (symlink)</li></em> -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * <li>binaries/README.html (symlink)</li></em> -<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * <li>source/HEADER.html (symlink)</li></em> -<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * <li>source/README.html (symlink)</li></em> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * <li>HEADER.html</li></em> -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * <li>README.html</li></em> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * </li></em> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * @return the {@link List} of created files above</em> -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs in the creation of these</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * files fails.</em> -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">private</strong> List<File> buildReadmeAndHeaderHtmlFiles() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L411" href="#L411">411</a> List<File> headerAndReadmeFiles = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L412" href="#L412">412</a> File headerFile = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, HEADER_FILE_NAME); -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_comment">//</em> -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_comment">// HEADER file</em> -<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_comment">//</em> -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">try</strong> (Writer headerWriter = <strong class="jxr_keyword">new</strong> OutputStreamWriter(<strong class="jxr_keyword">new</strong> FileOutputStream(headerFile), <span class="jxr_string">"UTF-8"</span>)) { -<a class="jxr_linenumber" name="L417" href="#L417">417</a> HeaderHtmlVelocityDelegate.builder().build().render(headerWriter); -<a class="jxr_linenumber" name="L418" href="#L418">418</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"Could not build HEADER html file "</span> + headerFile; -<a class="jxr_linenumber" name="L420" href="#L420">420</a> getLog().error(message, e); -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); -<a class="jxr_linenumber" name="L422" href="#L422">422</a> } -<a class="jxr_linenumber" name="L423" href="#L423">423</a> headerAndReadmeFiles.add(headerFile); -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_comment">//</em> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_comment">// README file</em> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_comment">//</em> -<a class="jxr_linenumber" name="L427" href="#L427">427</a> File readmeFile = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, README_FILE_NAME); -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">try</strong> (Writer readmeWriter = <strong class="jxr_keyword">new</strong> OutputStreamWriter(<strong class="jxr_keyword">new</strong> FileOutputStream(readmeFile), <span class="jxr_string">"UTF-8"</span>)) { -<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_comment">// @formatter:off</em> -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <a href="../../../../../../org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html">ReadmeHtmlVelocityDelegate</a> readmeHtmlVelocityDelegate = ReadmeHtmlVelocityDelegate.builder() -<a class="jxr_linenumber" name="L431" href="#L431">431</a> .withArtifactId(project.getArtifactId()) -<a class="jxr_linenumber" name="L432" href="#L432">432</a> .withVersion(project.getVersion()) -<a class="jxr_linenumber" name="L433" href="#L433">433</a> .withSiteUrl(project.getUrl()) -<a class="jxr_linenumber" name="L434" href="#L434">434</a> .build(); -<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_comment">// @formatter:on</em> -<a class="jxr_linenumber" name="L436" href="#L436">436</a> readmeHtmlVelocityDelegate.render(readmeWriter); -<a class="jxr_linenumber" name="L437" href="#L437">437</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"Could not build README html file "</span> + readmeFile; -<a class="jxr_linenumber" name="L439" href="#L439">439</a> getLog().error(message, e); -<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); -<a class="jxr_linenumber" name="L441" href="#L441">441</a> } -<a class="jxr_linenumber" name="L442" href="#L442">442</a> headerAndReadmeFiles.add(readmeFile); -<a class="jxr_linenumber" name="L443" href="#L443">443</a> headerAndReadmeFiles.addAll(copyHeaderAndReadmeToSubdirectories(headerFile, readmeFile)); -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">return</strong> headerAndReadmeFiles; -<a class="jxr_linenumber" name="L445" href="#L445">445</a> } -<a class="jxr_linenumber" name="L446" href="#L446">446</a> -<a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> * Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries</em> -<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> * directories.</em> -<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * @param headerFile The originally created <code>HEADER.html</code> file.</em> -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> * @param readmeFile The originally created <code>README.html</code> file.</em> -<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> * @return a {@link List} of created files.</em> -<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the {@link SharedFunctions#copyFile(Log, File, File)}</em> -<a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> * fails.</em> -<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">private</strong> List<File> copyHeaderAndReadmeToSubdirectories(File headerFile, File readmeFile) -<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L459" href="#L459">459</a> List<File> symbolicLinkFiles = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L460" href="#L460">460</a> File sourceRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"source"</span>); -<a class="jxr_linenumber" name="L461" href="#L461">461</a> File binariesRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"binaries"</span>); -<a class="jxr_linenumber" name="L462" href="#L462">462</a> File sourceHeaderFile = <strong class="jxr_keyword">new</strong> File(sourceRoot, HEADER_FILE_NAME); -<a class="jxr_linenumber" name="L463" href="#L463">463</a> File sourceReadmeFile = <strong class="jxr_keyword">new</strong> File(sourceRoot, README_FILE_NAME); -<a class="jxr_linenumber" name="L464" href="#L464">464</a> File binariesHeaderFile = <strong class="jxr_keyword">new</strong> File(binariesRoot, HEADER_FILE_NAME); -<a class="jxr_linenumber" name="L465" href="#L465">465</a> File binariesReadmeFile = <strong class="jxr_keyword">new</strong> File(binariesRoot, README_FILE_NAME); -<a class="jxr_linenumber" name="L466" href="#L466">466</a> SharedFunctions.copyFile(getLog(), headerFile, sourceHeaderFile); -<a class="jxr_linenumber" name="L467" href="#L467">467</a> symbolicLinkFiles.add(sourceHeaderFile); -<a class="jxr_linenumber" name="L468" href="#L468">468</a> SharedFunctions.copyFile(getLog(), readmeFile, sourceReadmeFile); -<a class="jxr_linenumber" name="L469" href="#L469">469</a> symbolicLinkFiles.add(sourceReadmeFile); -<a class="jxr_linenumber" name="L470" href="#L470">470</a> SharedFunctions.copyFile(getLog(), headerFile, binariesHeaderFile); -<a class="jxr_linenumber" name="L471" href="#L471">471</a> symbolicLinkFiles.add(binariesHeaderFile); -<a class="jxr_linenumber" name="L472" href="#L472">472</a> SharedFunctions.copyFile(getLog(), readmeFile, binariesReadmeFile); -<a class="jxr_linenumber" name="L473" href="#L473">473</a> symbolicLinkFiles.add(binariesReadmeFile); -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">return</strong> symbolicLinkFiles; -<a class="jxr_linenumber" name="L475" href="#L475">475</a> } -<a class="jxr_linenumber" name="L476" href="#L476">476</a> -<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> * This method is the setter for the {@link CommonsDistributionStagingMojo#baseDir} field, specifically</em> -<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> * for the usage in the unit tests.</em> -<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> * @param baseDir is the {@link File} to be used as the project's root directory when this mojo</em> -<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> * is invoked.</em> -<a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L484" href="#L484">484</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setBaseDir(File baseDir) { -<a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">this</strong>.baseDir = baseDir; -<a class="jxr_linenumber" name="L486" href="#L486">486</a> } -<a class="jxr_linenumber" name="L487" href="#L487">487</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">final</strong> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">final</strong> ScmProvider provider = scmManager.getProviderByRepository(repository); +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">final</strong> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository +<a class="jxr_linenumber" name="L208" href="#L208">208</a> .getProviderRepository(); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> SharedFunctions.setAuthentication( +<a class="jxr_linenumber" name="L210" href="#L210">210</a> providerRepository, +<a class="jxr_linenumber" name="L211" href="#L211">211</a> distServer, +<a class="jxr_linenumber" name="L212" href="#L212">212</a> settings, +<a class="jxr_linenumber" name="L213" href="#L213">213</a> settingsDecrypter, +<a class="jxr_linenumber" name="L214" href="#L214">214</a> username, +<a class="jxr_linenumber" name="L215" href="#L215">215</a> password +<a class="jxr_linenumber" name="L216" href="#L216">216</a> ); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> distVersionRcVersionDirectory = +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory, commonsReleaseVersion + <span class="jxr_string">"-"</span> + commonsRcVersion); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">if</strong> (!distCheckoutDirectory.exists()) { +<a class="jxr_linenumber" name="L220" href="#L220">220</a> SharedFunctions.initDirectory(getLog(), distCheckoutDirectory); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">final</strong> ScmFileSet scmFileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> getLog().info(<span class="jxr_string">"Checking out dist from: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">final</strong> CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (!checkOutResult.isSuccess()) { +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to checkout files from SCM: "</span> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> + checkOutResult.getProviderMessage() + <span class="jxr_string">" ["</span> + checkOutResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L228" href="#L228">228</a> } +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">final</strong> File copiedReleaseNotes = copyReleaseNotesToWorkingDirectory(); +<a class="jxr_linenumber" name="L230" href="#L230">230</a> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(copiedReleaseNotes, +<a class="jxr_linenumber" name="L231" href="#L231">231</a> provider, repository); +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">final</strong> List<File> filesToAdd = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L233" href="#L233">233</a> listNotHiddenFilesAndDirectories(distCheckoutDirectory, filesToAdd); +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">if</strong> (!dryRun) { +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">final</strong> ScmFileSet fileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory, filesToAdd); +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">final</strong> AddScmResult addResult = provider.add( +<a class="jxr_linenumber" name="L237" href="#L237">237</a> repository, +<a class="jxr_linenumber" name="L238" href="#L238">238</a> fileSet +<a class="jxr_linenumber" name="L239" href="#L239">239</a> ); +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (!addResult.isSuccess()) { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to add files to SCM: "</span> + addResult.getProviderMessage() +<a class="jxr_linenumber" name="L242" href="#L242">242</a> + <span class="jxr_string">" ["</span> + addResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L243" href="#L243">243</a> } +<a class="jxr_linenumber" name="L244" href="#L244">244</a> getLog().info(<span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">final</strong> CheckInScmResult checkInResult = provider.checkIn( +<a class="jxr_linenumber" name="L246" href="#L246">246</a> repository, +<a class="jxr_linenumber" name="L247" href="#L247">247</a> fileSet, +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion() +<a class="jxr_linenumber" name="L249" href="#L249">249</a> ); +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">if</strong> (!checkInResult.isSuccess()) { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> getLog().error(<span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput()); +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput() +<a class="jxr_linenumber" name="L254" href="#L254">254</a> ); +<a class="jxr_linenumber" name="L255" href="#L255">255</a> } +<a class="jxr_linenumber" name="L256" href="#L256">256</a> getLog().info(<span class="jxr_string">"Committed revision "</span> + checkInResult.getScmRevision()); +<a class="jxr_linenumber" name="L257" href="#L257">257</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L258" href="#L258">258</a> getLog().info(<span class="jxr_string">"[Dry run] Would have committed to: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L259" href="#L259">259</a> getLog().info( +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <span class="jxr_string">"[Dry run] Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); +<a class="jxr_linenumber" name="L261" href="#L261">261</a> } +<a class="jxr_linenumber" name="L262" href="#L262">262</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> ScmException e) { +<a class="jxr_linenumber" name="L263" href="#L263">263</a> getLog().error(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); +<a class="jxr_linenumber" name="L265" href="#L265">265</a> } +<a class="jxr_linenumber" name="L266" href="#L266">266</a> } +<a class="jxr_linenumber" name="L267" href="#L267">267</a> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Lists all directories and files to a flat list.</em> +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @param directory {@link File} containing directory to list</em> +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param files a {@link List} of {@link File} to which to append the files.</em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> listNotHiddenFilesAndDirectories(<strong class="jxr_keyword">final</strong> File directory, <strong class="jxr_keyword">final</strong> List<File> files) { +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_comment">// Get all the files and directories from a directory.</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">final</strong> File[] fList = directory.listFiles(); +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> File file : fList) { +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">if</strong> (file.isFile() && !file.isHidden()) { +<a class="jxr_linenumber" name="L278" href="#L278">278</a> files.add(file); +<a class="jxr_linenumber" name="L279" href="#L279">279</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.isDirectory() && !file.isHidden()) { +<a class="jxr_linenumber" name="L280" href="#L280">280</a> files.add(file); +<a class="jxr_linenumber" name="L281" href="#L281">281</a> listNotHiddenFilesAndDirectories(file, files); +<a class="jxr_linenumber" name="L282" href="#L282">282</a> } +<a class="jxr_linenumber" name="L283" href="#L283">283</a> } +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } +<a class="jxr_linenumber" name="L285" href="#L285">285</a> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @return the RELEASE-NOTES.txt file that exists in the <code>target/commons-release-notes/scm</code></em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * directory for the purpose of adding it to the scm change set in the method</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * {@link CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * ScmProvider, ScmRepository)}.</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs as a wrapper so that maven</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * can properly handle the exception.</em> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">private</strong> File copyReleaseNotesToWorkingDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L298" href="#L298">298</a> SharedFunctions.initDirectory(getLog(), distVersionRcVersionDirectory); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> getLog().info(<span class="jxr_string">"Copying RELEASE-NOTES.txt to working directory."</span>); +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">final</strong> File copiedReleaseNotes = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, releaseNotesFile.getName()); +<a class="jxr_linenumber" name="L301" href="#L301">301</a> SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes); +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">return</strong> copiedReleaseNotes; +<a class="jxr_linenumber" name="L303" href="#L303">303</a> } +<a class="jxr_linenumber" name="L304" href="#L304">304</a> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into</em> +<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * the directory structure of the distribution staging repository. Specifically:</em> +<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * <li>root:</em> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * <li>site</li></em> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * <li>site.zip</li></em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * <li>RELEASE-NOTES.txt</li></em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * <li>source:</em> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * <li>-src artifacts....</li></em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * <li>binaries:</em> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * <li>-bin artifacts....</li></em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * @param copiedReleaseNotes is the RELEASE-NOTES.txt file that exists in the</em> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * <code>target/commons-release-plugin/scm</code> directory.</em> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @param provider is the {@link ScmProvider} that we will use for adding the files we wish to commit.</em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * @param repository is the {@link ScmRepository} that we will use for adding the files that we wish to commit.</em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven</em> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * {@link ScmFileSet}.</em> +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs so that Maven can handle it properly.</em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">private</strong> List<File> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(<strong class="jxr_keyword">final</strong> File copiedReleaseNotes, +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">final</strong> ScmProvider provider, +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">final</strong> ScmRepository repository) +<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">final</strong> List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles()); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">final</strong> List<File> filesForMavenScmFileSet = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">final</strong> File scmBinariesRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"binaries"</span>); +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">final</strong> File scmSourceRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"source"</span>); +<a class="jxr_linenumber" name="L344" href="#L344">344</a> SharedFunctions.initDirectory(getLog(), scmBinariesRoot); +<a class="jxr_linenumber" name="L345" href="#L345">345</a> SharedFunctions.initDirectory(getLog(), scmSourceRoot); +<a class="jxr_linenumber" name="L346" href="#L346">346</a> File copy; +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> File file : workingDirectoryFiles) { +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"src"</span>)) { +<a class="jxr_linenumber" name="L349" href="#L349">349</a> copy = <strong class="jxr_keyword">new</strong> File(scmSourceRoot, file.getName()); +<a class="jxr_linenumber" name="L350" href="#L350">350</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L351" href="#L351">351</a> filesForMavenScmFileSet.add(file); +<a class="jxr_linenumber" name="L352" href="#L352">352</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"bin"</span>)) { +<a class="jxr_linenumber" name="L353" href="#L353">353</a> copy = <strong class="jxr_keyword">new</strong> File(scmBinariesRoot, file.getName()); +<a class="jxr_linenumber" name="L354" href="#L354">354</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L355" href="#L355">355</a> filesForMavenScmFileSet.add(file); +<a class="jxr_linenumber" name="L356" href="#L356">356</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (StringUtils.containsAny(file.getName(), <span class="jxr_string">"scm"</span>, <span class="jxr_string">"sha256.properties"</span>, <span class="jxr_string">"sha512.properties"</span>)) { +<a class="jxr_linenumber" name="L357" href="#L357">357</a> getLog().debug(<span class="jxr_string">"Not copying scm directory over to the scm directory because it is the scm directory."</span>); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_comment">//do nothing because we are copying into scm</em> +<a class="jxr_linenumber" name="L359" href="#L359">359</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L360" href="#L360">360</a> copy = <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory.getAbsolutePath(), file.getName()); +<a class="jxr_linenumber" name="L361" href="#L361">361</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L362" href="#L362">362</a> filesForMavenScmFileSet.add(file); +<a class="jxr_linenumber" name="L363" href="#L363">363</a> } +<a class="jxr_linenumber" name="L364" href="#L364">364</a> } +<a class="jxr_linenumber" name="L365" href="#L365">365</a> filesForMavenScmFileSet.addAll(buildReadmeAndHeaderHtmlFiles()); +<a class="jxr_linenumber" name="L366" href="#L366">366</a> filesForMavenScmFileSet.addAll(copySiteToScmDirectory()); +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">return</strong> filesForMavenScmFileSet; +<a class="jxr_linenumber" name="L368" href="#L368">368</a> } +<a class="jxr_linenumber" name="L369" href="#L369">369</a> +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</em> +<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * @return the {@link List} of {@link File}'s contained in</em> +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * <code>${basedir}/target/commons-release-plugin/scm/site</code>, after the copy is complete.</em> +<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the site copying fails for some reason.</em> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">private</strong> List<File> copySiteToScmDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">if</strong> (!siteDirectory.exists()) { +<a class="jxr_linenumber" name="L379" href="#L379">379</a> getLog().error(<span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span>); +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> +<a class="jxr_linenumber" name="L382" href="#L382">382</a> ); +<a class="jxr_linenumber" name="L383" href="#L383">383</a> } +<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">final</strong> File siteInScm = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"site"</span>); +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L386" href="#L386">386</a> FileUtils.copyDirectory(siteDirectory, siteInScm); +<a class="jxr_linenumber" name="L387" href="#L387">387</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Site copying failed"</span>, e); +<a class="jxr_linenumber" name="L389" href="#L389">389</a> } +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ArrayList<>(FileUtils.listFiles(siteInScm, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">true</strong>)); +<a class="jxr_linenumber" name="L391" href="#L391">391</a> } +<a class="jxr_linenumber" name="L392" href="#L392">392</a> +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</em> +<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * <li>distRoot</em> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * <li>binaries/HEADER.html (symlink)</li></em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * <li>binaries/README.html (symlink)</li></em> +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * <li>source/HEADER.html (symlink)</li></em> +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * <li>source/README.html (symlink)</li></em> +<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * <li>HEADER.html</li></em> +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * <li>README.html</li></em> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * @return the {@link List} of created files above</em> +<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs in the creation of these</em> +<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * files fails.</em> +<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">private</strong> List<File> buildReadmeAndHeaderHtmlFiles() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">final</strong> List<File> headerAndReadmeFiles = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">final</strong> File headerFile = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, HEADER_FILE_NAME); +<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_comment">// HEADER file</em> +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">try</strong> (Writer headerWriter = <strong class="jxr_keyword">new</strong> OutputStreamWriter(<strong class="jxr_keyword">new</strong> FileOutputStream(headerFile), <span class="jxr_string">"UTF-8"</span>)) { +<a class="jxr_linenumber" name="L418" href="#L418">418</a> HeaderHtmlVelocityDelegate.builder().build().render(headerWriter); +<a class="jxr_linenumber" name="L419" href="#L419">419</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"Could not build HEADER html file "</span> + headerFile; +<a class="jxr_linenumber" name="L421" href="#L421">421</a> getLog().error(message, e); +<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); +<a class="jxr_linenumber" name="L423" href="#L423">423</a> } +<a class="jxr_linenumber" name="L424" href="#L424">424</a> headerAndReadmeFiles.add(headerFile); +<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_comment">// README file</em> +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">final</strong> File readmeFile = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, README_FILE_NAME); +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">try</strong> (Writer readmeWriter = <strong class="jxr_keyword">new</strong> OutputStreamWriter(<strong class="jxr_keyword">new</strong> FileOutputStream(readmeFile), <span class="jxr_string">"UTF-8"</span>)) { +<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_comment">// @formatter:off</em> +<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">final</strong> <a name="ReadmeHtmlVelocityDelegate" href="../../../../../../org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#ReadmeHtmlVelocityDelegate">ReadmeHtmlVelocityDelegate</a> readmeHtmlVelocityDelegate = ReadmeHtmlVelocityDelegate.builder() +<a class="jxr_linenumber" name="L432" href="#L432">432</a> .withArtifactId(project.getArtifactId()) +<a class="jxr_linenumber" name="L433" href="#L433">433</a> .withVersion(project.getVersion()) +<a class="jxr_linenumber" name="L434" href="#L434">434</a> .withSiteUrl(project.getUrl()) +<a class="jxr_linenumber" name="L435" href="#L435">435</a> .build(); +<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_comment">// @formatter:on</em> +<a class="jxr_linenumber" name="L437" href="#L437">437</a> readmeHtmlVelocityDelegate.render(readmeWriter); +<a class="jxr_linenumber" name="L438" href="#L438">438</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"Could not build README html file "</span> + readmeFile; +<a class="jxr_linenumber" name="L440" href="#L440">440</a> getLog().error(message, e); +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); +<a class="jxr_linenumber" name="L442" href="#L442">442</a> } +<a class="jxr_linenumber" name="L443" href="#L443">443</a> headerAndReadmeFiles.add(readmeFile); +<a class="jxr_linenumber" name="L444" href="#L444">444</a> headerAndReadmeFiles.addAll(copyHeaderAndReadmeToSubdirectories(headerFile, readmeFile)); +<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">return</strong> headerAndReadmeFiles; +<a class="jxr_linenumber" name="L446" href="#L446">446</a> } +<a class="jxr_linenumber" name="L447" href="#L447">447</a> +<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> * Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries</em> +<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> * directories.</em> +<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> * @param headerFile The originally created <code>HEADER.html</code> file.</em> +<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> * @param readmeFile The originally created <code>README.html</code> file.</em> +<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> * @return a {@link List} of created files.</em> +<a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the {@link SharedFunctions#copyFile(Log, File, File)}</em> +<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment"> * fails.</em> +<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">private</strong> List<File> copyHeaderAndReadmeToSubdirectories(<strong class="jxr_keyword">final</strong> File headerFile, <strong class="jxr_keyword">final</strong> File readmeFile) +<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">final</strong> List<File> symbolicLinkFiles = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L461" href="#L461">461</a> <strong class="jxr_keyword">final</strong> File sourceRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"source"</span>); +<a class="jxr_linenumber" name="L462" href="#L462">462</a> <strong class="jxr_keyword">final</strong> File binariesRoot = <strong class="jxr_keyword">new</strong> File(distVersionRcVersionDirectory, <span class="jxr_string">"binaries"</span>); +<a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong class="jxr_keyword">final</strong> File sourceHeaderFile = <strong class="jxr_keyword">new</strong> File(sourceRoot, HEADER_FILE_NAME); +<a class="jxr_linenumber" name="L464" href="#L464">464</a> <strong class="jxr_keyword">final</strong> File sourceReadmeFile = <strong class="jxr_keyword">new</strong> File(sourceRoot, README_FILE_NAME); +<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">final</strong> File binariesHeaderFile = <strong class="jxr_keyword">new</strong> File(binariesRoot, HEADER_FILE_NAME); +<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">final</strong> File binariesReadmeFile = <strong class="jxr_keyword">new</strong> File(binariesRoot, README_FILE_NAME); +<a class="jxr_linenumber" name="L467" href="#L467">467</a> SharedFunctions.copyFile(getLog(), headerFile, sourceHeaderFile); +<a class="jxr_linenumber" name="L468" href="#L468">468</a> symbolicLinkFiles.add(sourceHeaderFile); +<a class="jxr_linenumber" name="L469" href="#L469">469</a> SharedFunctions.copyFile(getLog(), readmeFile, sourceReadmeFile); +<a class="jxr_linenumber" name="L470" href="#L470">470</a> symbolicLinkFiles.add(sourceReadmeFile); +<a class="jxr_linenumber" name="L471" href="#L471">471</a> SharedFunctions.copyFile(getLog(), headerFile, binariesHeaderFile); +<a class="jxr_linenumber" name="L472" href="#L472">472</a> symbolicLinkFiles.add(binariesHeaderFile); +<a class="jxr_linenumber" name="L473" href="#L473">473</a> SharedFunctions.copyFile(getLog(), readmeFile, binariesReadmeFile); +<a class="jxr_linenumber" name="L474" href="#L474">474</a> symbolicLinkFiles.add(binariesReadmeFile); +<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">return</strong> symbolicLinkFiles; +<a class="jxr_linenumber" name="L476" href="#L476">476</a> } +<a class="jxr_linenumber" name="L477" href="#L477">477</a> +<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> * This method is the setter for the {@link CommonsDistributionStagingMojo#baseDir} field, specifically</em> +<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * for the usage in the unit tests.</em> +<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> * @param baseDir is the {@link File} to be used as the project's root directory when this mojo</em> +<a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> * is invoked.</em> +<a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setBaseDir(<strong class="jxr_keyword">final</strong> File baseDir) { +<a class="jxr_linenumber" name="L486" href="#L486">486</a> <strong class="jxr_keyword">this</strong>.baseDir = baseDir; +<a class="jxr_linenumber" name="L487" href="#L487">487</a> } +<a class="jxr_linenumber" name="L488" href="#L488">488</a> } </pre> <hr/>
[... 2 lines stripped ...]