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