Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,597 @@ +<!DOCTYPE HTML> +<html lang> +<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 class="source-page"> +<main role="main"> +<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> +<span class="source-line-no">288</span><span id="line-288"> }</span> +<span class="source-line-no">289</span><span id="line-289"> }</span> +<span class="source-line-no">290</span><span id="line-290"> }</span> +<span class="source-line-no">291</span><span id="line-291"></span> +<span class="source-line-no">292</span><span id="line-292"> /**</span> +<span class="source-line-no">293</span><span id="line-293"> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the</span> +<span class="source-line-no">294</span><span id="line-294"> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.</span> +<span class="source-line-no">295</span><span id="line-295"> *</span> +<span class="source-line-no">296</span><span id="line-296"> * @return the RELEASE-NOTES.txt file that exists in the <code>target/commons-release-notes/scm</code></span> +<span class="source-line-no">297</span><span id="line-297"> * directory for the purpose of adding it to the scm change set in the method</span> +<span class="source-line-no">298</span><span id="line-298"> * {@link CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,</span> +<span class="source-line-no">299</span><span id="line-299"> * ScmProvider, ScmRepository)}.</span> +<span class="source-line-no">300</span><span id="line-300"> * @throws MojoExecutionException if an {@link IOException} occurs as a wrapper so that maven</span> +<span class="source-line-no">301</span><span id="line-301"> * can properly handle the exception.</span> +<span class="source-line-no">302</span><span id="line-302"> */</span> +<span class="source-line-no">303</span><span id="line-303"> private File copyReleaseNotesToWorkingDirectory() throws MojoExecutionException {</span> +<span class="source-line-no">304</span><span id="line-304"> SharedFunctions.initDirectory(getLog(), distRcVersionDirectory);</span> +<span class="source-line-no">305</span><span id="line-305"> getLog().info("Copying RELEASE-NOTES.txt to working directory.");</span> +<span class="source-line-no">306</span><span id="line-306"> final File copiedReleaseNotes = new File(distRcVersionDirectory, releaseNotesFile.getName());</span> +<span class="source-line-no">307</span><span id="line-307"> SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes);</span> +<span class="source-line-no">308</span><span id="line-308"> return copiedReleaseNotes;</span> +<span class="source-line-no">309</span><span id="line-309"> }</span> +<span class="source-line-no">310</span><span id="line-310"></span> +<span class="source-line-no">311</span><span id="line-311"> /**</span> +<span class="source-line-no">312</span><span id="line-312"> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into</span> +<span class="source-line-no">313</span><span id="line-313"> * the directory structure of the distribution staging repository. Specifically:</span> +<span class="source-line-no">314</span><span id="line-314"> * <ul></span> +<span class="source-line-no">315</span><span id="line-315"> * <li>root:</span> +<span class="source-line-no">316</span><span id="line-316"> * <ul></span> +<span class="source-line-no">317</span><span id="line-317"> * <li>site</li></span> +<span class="source-line-no">318</span><span id="line-318"> * <li>site.zip</li></span> +<span class="source-line-no">319</span><span id="line-319"> * <li>RELEASE-NOTES.txt</li></span> +<span class="source-line-no">320</span><span id="line-320"> * <li>source:</span> +<span class="source-line-no">321</span><span id="line-321"> * <ul></span> +<span class="source-line-no">322</span><span id="line-322"> * <li>-src artifacts....</li></span> +<span class="source-line-no">323</span><span id="line-323"> * </ul></span> +<span class="source-line-no">324</span><span id="line-324"> * </li></span> +<span class="source-line-no">325</span><span id="line-325"> * <li>binaries:</span> +<span class="source-line-no">326</span><span id="line-326"> * <ul></span> +<span class="source-line-no">327</span><span id="line-327"> * <li>-bin artifacts....</li></span> +<span class="source-line-no">328</span><span id="line-328"> * </ul></span> +<span class="source-line-no">329</span><span id="line-329"> * </li></span> +<span class="source-line-no">330</span><span id="line-330"> * </ul></span> +<span class="source-line-no">331</span><span id="line-331"> * </li></span> +<span class="source-line-no">332</span><span id="line-332"> * </ul></span> +<span class="source-line-no">333</span><span id="line-333"> *</span> +<span class="source-line-no">334</span><span id="line-334"> * @param copiedReleaseNotes is the RELEASE-NOTES.txt file that exists in the</span> +<span class="source-line-no">335</span><span id="line-335"> * <code>target/commons-release-plugin/scm</code> directory.</span> +<span class="source-line-no">336</span><span id="line-336"> * @param provider is the {@link ScmProvider} that we will use for adding the files we wish to commit.</span> +<span class="source-line-no">337</span><span id="line-337"> * @param repository is the {@link ScmRepository} that we will use for adding the files that we wish to commit.</span> +<span class="source-line-no">338</span><span id="line-338"> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven</span> +<span class="source-line-no">339</span><span id="line-339"> * {@link ScmFileSet}.</span> +<span class="source-line-no">340</span><span id="line-340"> * @throws MojoExecutionException if an {@link IOException} occurs so that Maven can handle it properly.</span> +<span class="source-line-no">341</span><span id="line-341"> */</span> +<span class="source-line-no">342</span><span id="line-342"> private List<File> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(final File copiedReleaseNotes,</span> +<span class="source-line-no">343</span><span id="line-343"> final ScmProvider provider,</span> +<span class="source-line-no">344</span><span id="line-344"> final ScmRepository repository)</span> +<span class="source-line-no">345</span><span id="line-345"> throws MojoExecutionException {</span> +<span class="source-line-no">346</span><span id="line-346"> final List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles());</span> +<span class="source-line-no">347</span><span id="line-347"> final List<File> filesForMavenScmFileSet = new ArrayList<>();</span> +<span class="source-line-no">348</span><span id="line-348"> final File scmBinariesRoot = new File(distRcVersionDirectory, "binaries");</span> +<span class="source-line-no">349</span><span id="line-349"> final File scmSourceRoot = new File(distRcVersionDirectory, "source");</span> +<span class="source-line-no">350</span><span id="line-350"> SharedFunctions.initDirectory(getLog(), scmBinariesRoot);</span> +<span class="source-line-no">351</span><span id="line-351"> SharedFunctions.initDirectory(getLog(), scmSourceRoot);</span> +<span class="source-line-no">352</span><span id="line-352"> File copy;</span> +<span class="source-line-no">353</span><span id="line-353"> for (final File file : workingDirectoryFiles) {</span> +<span class="source-line-no">354</span><span id="line-354"> if (file.getName().contains("src")) {</span> +<span class="source-line-no">355</span><span id="line-355"> copy = new File(scmSourceRoot, file.getName());</span> +<span class="source-line-no">356</span><span id="line-356"> SharedFunctions.copyFile(getLog(), file, copy);</span> +<span class="source-line-no">357</span><span id="line-357"> filesForMavenScmFileSet.add(file);</span> +<span class="source-line-no">358</span><span id="line-358"> } else if (file.getName().contains("bin")) {</span> +<span class="source-line-no">359</span><span id="line-359"> copy = new File(scmBinariesRoot, file.getName());</span> +<span class="source-line-no">360</span><span id="line-360"> SharedFunctions.copyFile(getLog(), file, copy);</span> +<span class="source-line-no">361</span><span id="line-361"> filesForMavenScmFileSet.add(file);</span> +<span class="source-line-no">362</span><span id="line-362"> } else if (StringUtils.containsAny(file.getName(), "scm", "sha256.properties", "sha512.properties")) {</span> +<span class="source-line-no">363</span><span id="line-363"> getLog().debug("Not copying scm directory over to the scm directory because it is the scm directory.");</span> +<span class="source-line-no">364</span><span id="line-364"> //do nothing because we are copying into scm</span> +<span class="source-line-no">365</span><span id="line-365"> } else {</span> +<span class="source-line-no">366</span><span id="line-366"> copy = new File(distCheckoutDirectory.getAbsolutePath(), file.getName());</span> +<span class="source-line-no">367</span><span id="line-367"> SharedFunctions.copyFile(getLog(), file, copy);</span> +<span class="source-line-no">368</span><span id="line-368"> filesForMavenScmFileSet.add(file);</span> +<span class="source-line-no">369</span><span id="line-369"> }</span> +<span class="source-line-no">370</span><span id="line-370"> }</span> +<span class="source-line-no">371</span><span id="line-371"> filesForMavenScmFileSet.addAll(buildReadmeAndHeaderHtmlFiles());</span> +<span class="source-line-no">372</span><span id="line-372"> filesForMavenScmFileSet.add(copySignatureValidatorScriptToScmDirectory());</span> +<span class="source-line-no">373</span><span id="line-373"> filesForMavenScmFileSet.addAll(copySiteToScmDirectory());</span> +<span class="source-line-no">374</span><span id="line-374"> return filesForMavenScmFileSet;</span> +<span class="source-line-no">375</span><span id="line-375"> }</span> +<span class="source-line-no">376</span><span id="line-376"></span> +<span class="source-line-no">377</span><span id="line-377"> /**</span> +<span class="source-line-no">378</span><span id="line-378"> * Copies our <code>signature-validator.sh</code> script into</span> +<span class="source-line-no">379</span><span id="line-379"> * <code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</span> +<span class="source-line-no">380</span><span id="line-380"> *</span> +<span class="source-line-no">381</span><span id="line-381"> * @return the {@link File} for the signature-validator.sh</span> +<span class="source-line-no">382</span><span id="line-382"> * @throws MojoExecutionException if an error occurs while the resource is being copied</span> +<span class="source-line-no">383</span><span id="line-383"> */</span> +<span class="source-line-no">384</span><span id="line-384"> private File copySignatureValidatorScriptToScmDirectory() throws MojoExecutionException {</span> +<span class="source-line-no">385</span><span id="line-385"> final Path scmTargetPath = Paths.get(distRcVersionDirectory.toString(), SIGNATURE_VALIDATOR_NAME);</span> +<span class="source-line-no">386</span><span id="line-386"> final String name = "/resources/" + SIGNATURE_VALIDATOR_NAME;</span> +<span class="source-line-no">387</span><span id="line-387"> // The source can be in a local file or inside a jar file.</span> +<span class="source-line-no">388</span><span id="line-388"> try {</span> +<span class="source-line-no">389</span><span id="line-389"> PathUtils.copyFile(getClass().getResource(name), scmTargetPath);</span> +<span class="source-line-no">390</span><span id="line-390"> } catch (final Exception e) {</span> +<span class="source-line-no">391</span><span id="line-391"> throw new MojoExecutionException(String.format("Failed to copy '%s' to '%s'", name, scmTargetPath), e);</span> +<span class="source-line-no">392</span><span id="line-392"> }</span> +<span class="source-line-no">393</span><span id="line-393"> return scmTargetPath.toFile();</span> +<span class="source-line-no">394</span><span id="line-394"> }</span> +<span class="source-line-no">395</span><span id="line-395"></span> +<span class="source-line-no">396</span><span id="line-396"> /**</span> +<span class="source-line-no">397</span><span id="line-397"> * Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</span> +<span class="source-line-no">398</span><span id="line-398"> *</span> +<span class="source-line-no">399</span><span id="line-399"> * @return the {@link List} of {@link File}'s contained in</span> +<span class="source-line-no">400</span><span id="line-400"> * <code>${basedir}/target/commons-release-plugin/scm/site</code>, after the copy is complete.</span> +<span class="source-line-no">401</span><span id="line-401"> * @throws MojoExecutionException if the site copying fails for some reason.</span> +<span class="source-line-no">402</span><span id="line-402"> */</span> +<span class="source-line-no">403</span><span id="line-403"> private List<File> copySiteToScmDirectory() throws MojoExecutionException {</span> +<span class="source-line-no">404</span><span id="line-404"> if (!siteDirectory.exists()) {</span> +<span class="source-line-no">405</span><span id="line-405"> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");</span> +<span class="source-line-no">406</span><span id="line-406"> throw new MojoExecutionException(</span> +<span class="source-line-no">407</span><span id="line-407"> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> +<span class="source-line-no">408</span><span id="line-408"> );</span> +<span class="source-line-no">409</span><span id="line-409"> }</span> +<span class="source-line-no">410</span><span id="line-410"> final File siteInScm = new File(distRcVersionDirectory, "site");</span> +<span class="source-line-no">411</span><span id="line-411"> try {</span> +<span class="source-line-no">412</span><span id="line-412"> FileUtils.copyDirectory(siteDirectory, siteInScm);</span> +<span class="source-line-no">413</span><span id="line-413"> } catch (final IOException e) {</span> +<span class="source-line-no">414</span><span id="line-414"> throw new MojoExecutionException("Site copying failed", e);</span> +<span class="source-line-no">415</span><span id="line-415"> }</span> +<span class="source-line-no">416</span><span id="line-416"> return new ArrayList<>(FileUtils.listFiles(siteInScm, null, true));</span> +<span class="source-line-no">417</span><span id="line-417"> }</span> +<span class="source-line-no">418</span><span id="line-418"></span> +<span class="source-line-no">419</span><span id="line-419"> /**</span> +<span class="source-line-no">420</span><span id="line-420"> * Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</span> +<span class="source-line-no">421</span><span id="line-421"> * <ul></span> +<span class="source-line-no">422</span><span id="line-422"> * <li>distRoot</span> +<span class="source-line-no">423</span><span id="line-423"> * <ul></span> +<span class="source-line-no">424</span><span id="line-424"> * <li>binaries/HEADER.html (symlink)</li></span> +<span class="source-line-no">425</span><span id="line-425"> * <li>binaries/README.html (symlink)</li></span> +<span class="source-line-no">426</span><span id="line-426"> * <li>source/HEADER.html (symlink)</li></span> +<span class="source-line-no">427</span><span id="line-427"> * <li>source/README.html (symlink)</li></span> +<span class="source-line-no">428</span><span id="line-428"> * <li>HEADER.html</li></span> +<span class="source-line-no">429</span><span id="line-429"> * <li>README.html</li></span> +<span class="source-line-no">430</span><span id="line-430"> * </ul></span> +<span class="source-line-no">431</span><span id="line-431"> * </li></span> +<span class="source-line-no">432</span><span id="line-432"> * </ul></span> +<span class="source-line-no">433</span><span id="line-433"> * @return the {@link List} of created files above</span> +<span class="source-line-no">434</span><span id="line-434"> * @throws MojoExecutionException if an {@link IOException} occurs in the creation of these</span> +<span class="source-line-no">435</span><span id="line-435"> * files fails.</span> +<span class="source-line-no">436</span><span id="line-436"> */</span> +<span class="source-line-no">437</span><span id="line-437"> private List<File> buildReadmeAndHeaderHtmlFiles() throws MojoExecutionException {</span> +<span class="source-line-no">438</span><span id="line-438"> final List<File> headerAndReadmeFiles = new ArrayList<>();</span> +<span class="source-line-no">439</span><span id="line-439"> final File headerFile = new File(distRcVersionDirectory, HEADER_FILE_NAME);</span> +<span class="source-line-no">440</span><span id="line-440"> //</span> +<span class="source-line-no">441</span><span id="line-441"> // HEADER file</span> +<span class="source-line-no">442</span><span id="line-442"> //</span> +<span class="source-line-no">443</span><span id="line-443"> try (Writer headerWriter = new OutputStreamWriter(Files.newOutputStream(headerFile.toPath()),</span> +<span class="source-line-no">444</span><span id="line-444"> StandardCharsets.UTF_8)) {</span> +<span class="source-line-no">445</span><span id="line-445"> HeaderHtmlVelocityDelegate.builder().build().render(headerWriter);</span> +<span class="source-line-no">446</span><span id="line-446"> } catch (final IOException e) {</span> +<span class="source-line-no">447</span><span id="line-447"> final String message = "Could not build HEADER html file " + headerFile;</span> +<span class="source-line-no">448</span><span id="line-448"> getLog().error(message, e);</span> +<span class="source-line-no">449</span><span id="line-449"> throw new MojoExecutionException(message, e);</span> +<span class="source-line-no">450</span><span id="line-450"> }</span> +<span class="source-line-no">451</span><span id="line-451"> headerAndReadmeFiles.add(headerFile);</span> +<span class="source-line-no">452</span><span id="line-452"> //</span> +<span class="source-line-no">453</span><span id="line-453"> // README file</span> +<span class="source-line-no">454</span><span id="line-454"> //</span> +<span class="source-line-no">455</span><span id="line-455"> final File readmeFile = new File(distRcVersionDirectory, README_FILE_NAME);</span> +<span class="source-line-no">456</span><span id="line-456"> try (Writer readmeWriter = new OutputStreamWriter(Files.newOutputStream(readmeFile.toPath()),</span> +<span class="source-line-no">457</span><span id="line-457"> StandardCharsets.UTF_8)) {</span> +<span class="source-line-no">458</span><span id="line-458"> // @formatter:off</span> +<span class="source-line-no">459</span><span id="line-459"> final ReadmeHtmlVelocityDelegate readmeHtmlVelocityDelegate = ReadmeHtmlVelocityDelegate.builder()</span> +<span class="source-line-no">460</span><span id="line-460"> .withArtifactId(project.getArtifactId())</span> +<span class="source-line-no">461</span><span id="line-461"> .withVersion(project.getVersion())</span> +<span class="source-line-no">462</span><span id="line-462"> .withSiteUrl(project.getUrl())</span> +<span class="source-line-no">463</span><span id="line-463"> .build();</span> +<span class="source-line-no">464</span><span id="line-464"> // @formatter:on</span> +<span class="source-line-no">465</span><span id="line-465"> readmeHtmlVelocityDelegate.render(readmeWriter);</span> +<span class="source-line-no">466</span><span id="line-466"> } catch (final IOException e) {</span> +<span class="source-line-no">467</span><span id="line-467"> final String message = "Could not build README html file " + readmeFile;</span> +<span class="source-line-no">468</span><span id="line-468"> getLog().error(message, e);</span> +<span class="source-line-no">469</span><span id="line-469"> throw new MojoExecutionException(message, e);</span> +<span class="source-line-no">470</span><span id="line-470"> }</span> +<span class="source-line-no">471</span><span id="line-471"> headerAndReadmeFiles.add(readmeFile);</span> +<span class="source-line-no">472</span><span id="line-472"> //</span> +<span class="source-line-no">473</span><span id="line-473"> // signature-validator.sh file copy</span> +<span class="source-line-no">474</span><span id="line-474"> //</span> +<span class="source-line-no">475</span><span id="line-475"> headerAndReadmeFiles.addAll(copyHeaderAndReadmeToSubdirectories(headerFile, readmeFile));</span> +<span class="source-line-no">476</span><span id="line-476"> return headerAndReadmeFiles;</span> +<span class="source-line-no">477</span><span id="line-477"> }</span> +<span class="source-line-no">478</span><span id="line-478"></span> +<span class="source-line-no">479</span><span id="line-479"> /**</span> +<span class="source-line-no">480</span><span id="line-480"> * Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries</span> +<span class="source-line-no">481</span><span id="line-481"> * directories.</span> +<span class="source-line-no">482</span><span id="line-482"> *</span> +<span class="source-line-no">483</span><span id="line-483"> * @param headerFile The originally created <code>HEADER.html</code> file.</span> +<span class="source-line-no">484</span><span id="line-484"> * @param readmeFile The originally created <code>README.html</code> file.</span> +<span class="source-line-no">485</span><span id="line-485"> * @return a {@link List} of created files.</span> +<span class="source-line-no">486</span><span id="line-486"> * @throws MojoExecutionException if the {@link SharedFunctions#copyFile(Log, File, File)}</span> +<span class="source-line-no">487</span><span id="line-487"> * fails.</span> +<span class="source-line-no">488</span><span id="line-488"> */</span> +<span class="source-line-no">489</span><span id="line-489"> private List<File> copyHeaderAndReadmeToSubdirectories(final File headerFile, final File readmeFile)</span> +<span class="source-line-no">490</span><span id="line-490"> throws MojoExecutionException {</span> +<span class="source-line-no">491</span><span id="line-491"> final List<File> symbolicLinkFiles = new ArrayList<>();</span> +<span class="source-line-no">492</span><span id="line-492"> final File sourceRoot = new File(distRcVersionDirectory, "source");</span> +<span class="source-line-no">493</span><span id="line-493"> final File binariesRoot = new File(distRcVersionDirectory, "binaries");</span> +<span class="source-line-no">494</span><span id="line-494"> final File sourceHeaderFile = new File(sourceRoot, HEADER_FILE_NAME);</span> +<span class="source-line-no">495</span><span id="line-495"> final File sourceReadmeFile = new File(sourceRoot, README_FILE_NAME);</span> +<span class="source-line-no">496</span><span id="line-496"> final File binariesHeaderFile = new File(binariesRoot, HEADER_FILE_NAME);</span> +<span class="source-line-no">497</span><span id="line-497"> final File binariesReadmeFile = new File(binariesRoot, README_FILE_NAME);</span> +<span class="source-line-no">498</span><span id="line-498"> SharedFunctions.copyFile(getLog(), headerFile, sourceHeaderFile);</span> +<span class="source-line-no">499</span><span id="line-499"> symbolicLinkFiles.add(sourceHeaderFile);</span> +<span class="source-line-no">500</span><span id="line-500"> SharedFunctions.copyFile(getLog(), readmeFile, sourceReadmeFile);</span> +<span class="source-line-no">501</span><span id="line-501"> symbolicLinkFiles.add(sourceReadmeFile);</span> +<span class="source-line-no">502</span><span id="line-502"> SharedFunctions.copyFile(getLog(), headerFile, binariesHeaderFile);</span> +<span class="source-line-no">503</span><span id="line-503"> symbolicLinkFiles.add(binariesHeaderFile);</span> +<span class="source-line-no">504</span><span id="line-504"> SharedFunctions.copyFile(getLog(), readmeFile, binariesReadmeFile);</span> +<span class="source-line-no">505</span><span id="line-505"> symbolicLinkFiles.add(binariesReadmeFile);</span> +<span class="source-line-no">506</span><span id="line-506"> return symbolicLinkFiles;</span> +<span class="source-line-no">507</span><span id="line-507"> }</span> +<span class="source-line-no">508</span><span id="line-508"></span> +<span class="source-line-no">509</span><span id="line-509"> /**</span> +<span class="source-line-no">510</span><span id="line-510"> * This method is the setter for the {@link CommonsDistributionStagingMojo#baseDir} field, specifically</span> +<span class="source-line-no">511</span><span id="line-511"> * for the usage in the unit tests.</span> +<span class="source-line-no">512</span><span id="line-512"> *</span> +<span class="source-line-no">513</span><span id="line-513"> * @param baseDir is the {@link File} to be used as the project's root directory when this mojo</span> +<span class="source-line-no">514</span><span id="line-514"> * is invoked.</span> +<span class="source-line-no">515</span><span id="line-515"> */</span> +<span class="source-line-no">516</span><span id="line-516"> protected void setBaseDir(final File baseDir) {</span> +<span class="source-line-no">517</span><span id="line-517"> this.baseDir = baseDir;</span> +<span class="source-line-no">518</span><span id="line-518"> }</span> +<span class="source-line-no">519</span><span id="line-519">}</span> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</main> +</body> +</html>
Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,261 @@ +<!DOCTYPE HTML> +<html lang> +<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: CommonsSiteCompressionMojo"> +<meta name="generator" content="javadoc/SourceToHTMLConverter"> +<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> +</head> +<body class="source-page"> +<main role="main"> +<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.InputStream;</span> +<span class="source-line-no">022</span><span id="line-22">import java.io.OutputStream;</span> +<span class="source-line-no">023</span><span id="line-23">import java.nio.file.Files;</span> +<span class="source-line-no">024</span><span id="line-24">import java.util.ArrayList;</span> +<span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> +<span class="source-line-no">026</span><span id="line-26">import java.util.zip.ZipEntry;</span> +<span class="source-line-no">027</span><span id="line-27">import java.util.zip.ZipOutputStream;</span> +<span class="source-line-no">028</span><span id="line-28"></span> +<span class="source-line-no">029</span><span id="line-29">import org.apache.commons.io.IOUtils;</span> +<span class="source-line-no">030</span><span id="line-30">import org.apache.commons.lang3.StringUtils;</span> +<span class="source-line-no">031</span><span id="line-31">import org.apache.maven.plugin.AbstractMojo;</span> +<span class="source-line-no">032</span><span id="line-32">import org.apache.maven.plugin.MojoExecutionException;</span> +<span class="source-line-no">033</span><span id="line-33">import org.apache.maven.plugin.MojoFailureException;</span> +<span class="source-line-no">034</span><span id="line-34">import org.apache.maven.plugins.annotations.LifecyclePhase;</span> +<span class="source-line-no">035</span><span id="line-35">import org.apache.maven.plugins.annotations.Mojo;</span> +<span class="source-line-no">036</span><span id="line-36">import org.apache.maven.plugins.annotations.Parameter;</span> +<span class="source-line-no">037</span><span id="line-37"></span> +<span class="source-line-no">038</span><span id="line-38">/**</span> +<span class="source-line-no">039</span><span id="line-39"> * Takes the built <code>./target/site</code> directory and compresses it to</span> +<span class="source-line-no">040</span><span id="line-40"> * <code>./target/commons-release-plugin/site.zip</code>.</span> +<span class="source-line-no">041</span><span id="line-41"> *</span> +<span class="source-line-no">042</span><span id="line-42"> * @since 1.0</span> +<span class="source-line-no">043</span><span id="line-43"> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the</span> +<span class="source-line-no">044</span><span id="line-44"> * {@link CommonsDistributionStagingMojo}.</span> +<span class="source-line-no">045</span><span id="line-45"> */</span> +<span class="source-line-no">046</span><span id="line-46">@Deprecated</span> +<span class="source-line-no">047</span><span id="line-47">@Mojo(name = "compress-site",</span> +<span class="source-line-no">048</span><span id="line-48"> defaultPhase = LifecyclePhase.POST_SITE,</span> +<span class="source-line-no">049</span><span id="line-49"> threadSafe = true,</span> +<span class="source-line-no">050</span><span id="line-50"> aggregator = true)</span> +<span class="source-line-no">051</span><span id="line-51">public class CommonsSiteCompressionMojo extends AbstractMojo {</span> +<span class="source-line-no">052</span><span id="line-52"></span> +<span class="source-line-no">053</span><span id="line-53"> /**</span> +<span class="source-line-no">054</span><span id="line-54"> * The working directory for the plugin which, assuming the maven uses the default</span> +<span class="source-line-no">055</span><span id="line-55"> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</span> +<span class="source-line-no">056</span><span id="line-56"> */</span> +<span class="source-line-no">057</span><span id="line-57"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",</span> +<span class="source-line-no">058</span><span id="line-58"> property = "commons.outputDirectory")</span> +<span class="source-line-no">059</span><span id="line-59"> private File workingDirectory;</span> +<span class="source-line-no">060</span><span id="line-60"></span> +<span class="source-line-no">061</span><span id="line-61"> /**</span> +<span class="source-line-no">062</span><span id="line-62"> */</span> +<span class="source-line-no">063</span><span id="line-63"> @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")</span> +<span class="source-line-no">064</span><span id="line-64"> private File siteDirectory;</span> +<span class="source-line-no">065</span><span id="line-65"></span> +<span class="source-line-no">066</span><span id="line-66"> /**</span> +<span class="source-line-no">067</span><span id="line-67"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically</span> +<span class="source-line-no">068</span><span id="line-68"> * this would need to be of the form:</span> +<span class="source-line-no">069</span><span id="line-69"> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the</span> +<span class="source-line-no">070</span><span id="line-70"> * substring <code>https</code> is a requirement.</span> +<span class="source-line-no">071</span><span id="line-71"> */</span> +<span class="source-line-no">072</span><span id="line-72"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</span> +<span class="source-line-no">073</span><span id="line-73"> private String distSvnStagingUrl;</span> +<span class="source-line-no">074</span><span id="line-74"></span> +<span class="source-line-no">075</span><span id="line-75"> /**</span> +<span class="source-line-no">076</span><span id="line-76"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</span> +<span class="source-line-no">077</span><span id="line-77"> */</span> +<span class="source-line-no">078</span><span id="line-78"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</span> +<span class="source-line-no">079</span><span id="line-79"> private Boolean isDistModule;</span> +<span class="source-line-no">080</span><span id="line-80"></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 list of files to compress into the site.zip file.</span> +<span class="source-line-no">083</span><span id="line-83"> */</span> +<span class="source-line-no">084</span><span id="line-84"> private List<File> filesToCompress;</span> +<span class="source-line-no">085</span><span id="line-85"></span> +<span class="source-line-no">086</span><span id="line-86"> @Override</span> +<span class="source-line-no">087</span><span id="line-87"> public void execute() throws MojoExecutionException, MojoFailureException {</span> +<span class="source-line-no">088</span><span id="line-88"> if (!isDistModule) {</span> +<span class="source-line-no">089</span><span id="line-89"> getLog().info("This module is marked as a non distribution "</span> +<span class="source-line-no">090</span><span id="line-90"> + "or assembly module, and the plugin will not run.");</span> +<span class="source-line-no">091</span><span id="line-91"> return;</span> +<span class="source-line-no">092</span><span id="line-92"> }</span> +<span class="source-line-no">093</span><span id="line-93"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</span> +<span class="source-line-no">094</span><span id="line-94"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</span> +<span class="source-line-no">095</span><span id="line-95"> return;</span> +<span class="source-line-no">096</span><span id="line-96"> }</span> +<span class="source-line-no">097</span><span id="line-97"> if (!siteDirectory.exists()) {</span> +<span class="source-line-no">098</span><span id="line-98"> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");</span> +<span class="source-line-no">099</span><span id="line-99"> throw new MojoFailureException(</span> +<span class="source-line-no">100</span><span id="line-100"> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> +<span class="source-line-no">101</span><span id="line-101"> );</span> +<span class="source-line-no">102</span><span id="line-102"> }</span> +<span class="source-line-no">103</span><span id="line-103"> if (!workingDirectory.exists()) {</span> +<span class="source-line-no">104</span><span id="line-104"> getLog().info("Current project contains no distributions. Not executing.");</span> +<span class="source-line-no">105</span><span id="line-105"> return;</span> +<span class="source-line-no">106</span><span id="line-106"> }</span> +<span class="source-line-no">107</span><span id="line-107"> try {</span> +<span class="source-line-no">108</span><span id="line-108"> filesToCompress = new ArrayList<>();</span> +<span class="source-line-no">109</span><span id="line-109"> getAllSiteFiles(siteDirectory, filesToCompress);</span> +<span class="source-line-no">110</span><span id="line-110"> writeZipFile(workingDirectory, siteDirectory, filesToCompress);</span> +<span class="source-line-no">111</span><span id="line-111"> } catch (final IOException e) {</span> +<span class="source-line-no">112</span><span id="line-112"> getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);</span> +<span class="source-line-no">113</span><span id="line-113"> throw new MojoExecutionException(</span> +<span class="source-line-no">114</span><span id="line-114"> "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),</span> +<span class="source-line-no">115</span><span id="line-115"> e</span> +<span class="source-line-no">116</span><span id="line-116"> );</span> +<span class="source-line-no">117</span><span id="line-117"> }</span> +<span class="source-line-no">118</span><span id="line-118"> }</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"> * By default this method iterates across the <code>target/site</code> directory and adds all the files</span> +<span class="source-line-no">122</span><span id="line-122"> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.</span> +<span class="source-line-no">123</span><span id="line-123"> *</span> +<span class="source-line-no">124</span><span id="line-124"> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.</span> +<span class="source-line-no">125</span><span id="line-125"> * @param filesToCompress the {@link List} to which to add all the files.</span> +<span class="source-line-no">126</span><span id="line-126"> */</span> +<span class="source-line-no">127</span><span id="line-127"> private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {</span> +<span class="source-line-no">128</span><span id="line-128"> final File[] files = siteDirectory.listFiles();</span> +<span class="source-line-no">129</span><span id="line-129"> for (final File file : files) {</span> +<span class="source-line-no">130</span><span id="line-130"> filesToCompress.add(file);</span> +<span class="source-line-no">131</span><span id="line-131"> if (file.isDirectory()) {</span> +<span class="source-line-no">132</span><span id="line-132"> getAllSiteFiles(file, filesToCompress);</span> +<span class="source-line-no">133</span><span id="line-133"> }</span> +<span class="source-line-no">134</span><span id="line-134"> }</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"> /**</span> +<span class="source-line-no">138</span><span id="line-138"> * A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file</span> +<span class="source-line-no">139</span><span id="line-139"> * in the <code>workingDirectory</code>.</span> +<span class="source-line-no">140</span><span id="line-140"> *</span> +<span class="source-line-no">141</span><span id="line-141"> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.</span> +<span class="source-line-no">142</span><span id="line-142"> * @param directoryToZip is a {@link File} representing the directory of the site (normally</span> +<span class="source-line-no">143</span><span id="line-143"> * <code>target/site</code>).</span> +<span class="source-line-no">144</span><span id="line-144"> * @param fileList the list of files to be zipped up, generally generated by</span> +<span class="source-line-no">145</span><span id="line-145"> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.</span> +<span class="source-line-no">146</span><span id="line-146"> * @throws IOException when the copying of the files goes incorrectly.</span> +<span class="source-line-no">147</span><span id="line-147"> */</span> +<span class="source-line-no">148</span><span id="line-148"> private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)</span> +<span class="source-line-no">149</span><span id="line-149"> throws IOException {</span> +<span class="source-line-no">150</span><span id="line-150"> try (OutputStream fos = Files.newOutputStream(new File(outputDirectory.getAbsolutePath() + "/site.zip")</span> +<span class="source-line-no">151</span><span id="line-151"> .toPath());</span> +<span class="source-line-no">152</span><span id="line-152"> ZipOutputStream zos = new ZipOutputStream(fos)) {</span> +<span class="source-line-no">153</span><span id="line-153"> for (final File file : fileList) {</span> +<span class="source-line-no">154</span><span id="line-154"> if (!file.isDirectory()) { // we only ZIP files, not directories</span> +<span class="source-line-no">155</span><span id="line-155"> addToZip(directoryToZip, file, zos);</span> +<span class="source-line-no">156</span><span id="line-156"> }</span> +<span class="source-line-no">157</span><span id="line-157"> }</span> +<span class="source-line-no">158</span><span id="line-158"> }</span> +<span class="source-line-no">159</span><span id="line-159"> }</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"> * Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by</span> +<span class="source-line-no">163</span><span id="line-163"> * <code>zos</code>.</span> +<span class="source-line-no">164</span><span id="line-164"> *</span> +<span class="source-line-no">165</span><span id="line-165"> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are</span> +<span class="source-line-no">166</span><span id="line-166"> * compressing. Generally this is <code>target/site</code>.</span> +<span class="source-line-no">167</span><span id="line-167"> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.</span> +<span class="source-line-no">168</span><span id="line-168"> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.</span> +<span class="source-line-no">169</span><span id="line-169"> * @throws IOException if adding the <code>file</code> doesn't work out properly.</span> +<span class="source-line-no">170</span><span id="line-170"> */</span> +<span class="source-line-no">171</span><span id="line-171"> private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {</span> +<span class="source-line-no">172</span><span id="line-172"> try (InputStream fis = Files.newInputStream(file.toPath())) {</span> +<span class="source-line-no">173</span><span id="line-173"> // we want the zipEntry's path to be a relative path that is relative</span> +<span class="source-line-no">174</span><span id="line-174"> // to the directory being zipped, so chop off the rest of the path</span> +<span class="source-line-no">175</span><span id="line-175"> final String zipFilePath = file.getCanonicalPath().substring(</span> +<span class="source-line-no">176</span><span id="line-176"> directoryToZip.getCanonicalPath().length() + 1,</span> +<span class="source-line-no">177</span><span id="line-177"> file.getCanonicalPath().length());</span> +<span class="source-line-no">178</span><span id="line-178"> final ZipEntry zipEntry = new ZipEntry(zipFilePath);</span> +<span class="source-line-no">179</span><span id="line-179"> zos.putNextEntry(zipEntry);</span> +<span class="source-line-no">180</span><span id="line-180"> IOUtils.copy(fis, zos);</span> +<span class="source-line-no">181</span><span id="line-181"> }</span> +<span class="source-line-no">182</span><span id="line-182"> }</span> +<span class="source-line-no">183</span><span id="line-183">}</span> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</main> +</body> +</html>
