Added: dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,532 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>CommonsDistributionStagingMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.release.plugin.mojos; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.Writer; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.nio.charset.StandardCharsets; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.nio.file.Path; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.nio.file.Paths; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.FileUtils; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.file.PathUtils; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.release.plugin.SharedFunctions; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.ScmException; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.ScmFileSet; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.add.AddScmResult; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.checkin.CheckInScmResult; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.checkout.CheckOutScmResult; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.manager.BasicScmManager; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.manager.ScmManager; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.ScmProvider; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.repository.ScmRepository; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecrypter; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * This class checks out the dev distribution location, copies the distributions into that directory</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * structure under the <code>target/commons-release-plugin/scm</code> directory. Then commits the</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @since 1.0</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Mojo(name = <span class="jxr_string">"stage-distributions"</span>, +<a class="jxr_linenumber" name="L68" href="#L68">68</a> defaultPhase = LifecyclePhase.DEPLOY, +<a class="jxr_linenumber" name="L69" href="#L69">69</a> threadSafe = <strong class="jxr_keyword">true</strong>, +<a class="jxr_linenumber" name="L70" href="#L70">70</a> aggregator = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CommonsDistributionStagingMojo" href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#CommonsDistributionStagingMojo">CommonsDistributionStagingMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/** The name of file generated from the README.vm velocity template to be checked into the dist svn repo. */</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String README_FILE_NAME = <span class="jxr_string">"README.html"</span>; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/** The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo. */</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String HEADER_FILE_NAME = <span class="jxr_string">"HEADER.html"</span>; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/** The name of the signature validation shell script to be checked into the dist svn repo. */</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SIGNATURE_VALIDATOR_NAME = <span class="jxr_string">"signature-validator.sh"</span>; +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * The {@link MavenProject} object is essentially the context of the maven build at</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * a given time.</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * The {@link File} that contains a file to the root directory of the working project. Typically</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * this directory is where the <code>pom.xml</code> resides.</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}"</span>) +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> File baseDir; +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/** The location to which the site gets built during running <code>mvn site</code>. */</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/site"</span>, property = <span class="jxr_string">"commons.siteOutputDirectory"</span>) +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">private</strong> File siteDirectory; +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * that assumes that we're using the default maven <code>${project.build.directory}</code>.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, property = <span class="jxr_string">"commons.outputDirectory"</span>) +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * The location to which to check out the dist subversion repository under our working directory, which</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * was given above.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin/scm"</span>, +<a class="jxr_linenumber" name="L111" href="#L111">111</a> property = <span class="jxr_string">"commons.distCheckoutDirectory"</span>) +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">private</strong> File distCheckoutDirectory; +<a class="jxr_linenumber" name="L113" href="#L113">113</a> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}/RELEASE-NOTES.txt"</span>, property = <span class="jxr_string">"commons.releaseNotesLocation"</span>) +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">private</strong> File releaseNotesFile; +<a class="jxr_linenumber" name="L119" href="#L119">119</a> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * A boolean that determines whether or not we actually commit the files up to the subversion repository.</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * If this is set to {@code true}, we do all but make the commits. We do checkout the repository in question</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * though.</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Parameter(property = <span class="jxr_string">"commons.release.dryRun"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> Boolean dryRun; +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * be of the form: <code>scm:svn:<a href="https://dist.apache.org/repos/dist/dev/commons/foo/version-RC"; target="alexandria_uri">https://dist.apache.org/repos/dist/dev/commons/foo/version-RC</a>#</code>. Note. that</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * the prefix to the substring <code>https</code> is a requirement.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> @Parameter(defaultValue = <span class="jxr_string">""</span>, property = <span class="jxr_string">"commons.distSvnStagingUrl"</span>) +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">private</strong> String distSvnStagingUrl; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>, property = <span class="jxr_string">"commons.release.isDistModule"</span>) +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">private</strong> Boolean isDistModule; +<a class="jxr_linenumber" name="L141" href="#L141">141</a> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * The release version of the artifact to be built.</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Parameter(property = <span class="jxr_string">"commons.release.version"</span>) +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">private</strong> String commonsReleaseVersion; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * The RC version of the release. For example the first voted on candidate would be "RC1".</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> @Parameter(property = <span class="jxr_string">"commons.rc.version"</span>) +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">private</strong> String commonsRcVersion; +<a class="jxr_linenumber" name="L153" href="#L153">153</a> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * The ID of the server (specified in settings.xml) which should be used for dist authentication.</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * This will be used in preference to {@link #username}/{@link #password}.</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> @Parameter(property = <span class="jxr_string">"commons.distServer"</span>) +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">private</strong> String distServer; +<a class="jxr_linenumber" name="L160" href="#L160">160</a> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * The username for the distribution subversion repository. This is typically your Apache id.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> @Parameter(property = <span class="jxr_string">"user.name"</span>) +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">private</strong> String username; +<a class="jxr_linenumber" name="L166" href="#L166">166</a> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * The password associated with {@link CommonsDistributionStagingMojo#username}.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> @Parameter(property = <span class="jxr_string">"user.password"</span>) +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">private</strong> String password; +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Maven {@link Settings}.</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> @Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">private</strong> Settings settings; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * Maven {@link SettingsDecrypter} component.</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> @Component +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> SettingsDecrypter settingsDecrypter; +<a class="jxr_linenumber" name="L184" href="#L184">184</a> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * A subdirectory of the dist directory into which we are going to stage the release candidate. We</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * build this up in the {@link CommonsDistributionStagingMojo#execute()} method. And, for example,</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * the directory should look like <code><a href="https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>."; target="alexandria_uri">https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</a></em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">private</strong> File distRcVersionDirectory; +<a class="jxr_linenumber" name="L191" href="#L191">191</a> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> @Override +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">if</strong> (!isDistModule) { +<a class="jxr_linenumber" name="L195" href="#L195">195</a> getLog().info(<span class="jxr_string">"This module is marked as a non distribution "</span> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> + <span class="jxr_string">"or assembly module, and the plugin will not run."</span>); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(distSvnStagingUrl)) { +<a class="jxr_linenumber" name="L200" href="#L200">200</a> getLog().warn(<span class="jxr_string">"commons.distSvnStagingUrl is not set, the commons-release-plugin will not run."</span>); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L202" href="#L202">202</a> } +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L204" href="#L204">204</a> getLog().info(<span class="jxr_string">"Current project contains no distributions. Not executing."</span>); +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L206" href="#L206">206</a> } +<a class="jxr_linenumber" name="L207" href="#L207">207</a> getLog().info(<span class="jxr_string">"Preparing to stage distributions"</span>); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">final</strong> ScmManager scmManager = <strong class="jxr_keyword">new</strong> BasicScmManager(); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> scmManager.setScmProvider(<span class="jxr_string">"svn"</span>, <strong class="jxr_keyword">new</strong> SvnExeScmProvider()); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">final</strong> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">final</strong> ScmProvider provider = scmManager.getProviderByRepository(repository); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">final</strong> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository +<a class="jxr_linenumber" name="L214" href="#L214">214</a> .getProviderRepository(); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> SharedFunctions.setAuthentication( +<a class="jxr_linenumber" name="L216" href="#L216">216</a> providerRepository, +<a class="jxr_linenumber" name="L217" href="#L217">217</a> distServer, +<a class="jxr_linenumber" name="L218" href="#L218">218</a> settings, +<a class="jxr_linenumber" name="L219" href="#L219">219</a> settingsDecrypter, +<a class="jxr_linenumber" name="L220" href="#L220">220</a> username, +<a class="jxr_linenumber" name="L221" href="#L221">221</a> password +<a class="jxr_linenumber" name="L222" href="#L222">222</a> ); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> distRcVersionDirectory = +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory, commonsReleaseVersion + <span class="jxr_string">"-"</span> + commonsRcVersion); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (!distCheckoutDirectory.exists()) { +<a class="jxr_linenumber" name="L226" href="#L226">226</a> SharedFunctions.initDirectory(getLog(), distCheckoutDirectory); +<a class="jxr_linenumber" name="L227" href="#L227">227</a> } +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">final</strong> ScmFileSet scmFileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory); +<a class="jxr_linenumber" name="L229" href="#L229">229</a> getLog().info(<span class="jxr_string">"Checking out dist from: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">final</strong> CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (!checkOutResult.isSuccess()) { +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to checkout files from SCM: "</span> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> + checkOutResult.getProviderMessage() + <span class="jxr_string">" ["</span> + checkOutResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L234" href="#L234">234</a> } +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">final</strong> File copiedReleaseNotes = copyReleaseNotesToWorkingDirectory(); +<a class="jxr_linenumber" name="L236" href="#L236">236</a> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(copiedReleaseNotes, +<a class="jxr_linenumber" name="L237" href="#L237">237</a> provider, repository); +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">final</strong> List<File> filesToAdd = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L239" href="#L239">239</a> listNotHiddenFilesAndDirectories(distCheckoutDirectory, filesToAdd); +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (!dryRun) { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">final</strong> ScmFileSet fileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory, filesToAdd); +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">final</strong> AddScmResult addResult = provider.add( +<a class="jxr_linenumber" name="L243" href="#L243">243</a> repository, +<a class="jxr_linenumber" name="L244" href="#L244">244</a> fileSet +<a class="jxr_linenumber" name="L245" href="#L245">245</a> ); +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (!addResult.isSuccess()) { +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to add files to SCM: "</span> + addResult.getProviderMessage() +<a class="jxr_linenumber" name="L248" href="#L248">248</a> + <span class="jxr_string">" ["</span> + addResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L249" href="#L249">249</a> } +<a class="jxr_linenumber" name="L250" href="#L250">250</a> getLog().info(<span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">final</strong> CheckInScmResult checkInResult = provider.checkIn( +<a class="jxr_linenumber" name="L252" href="#L252">252</a> repository, +<a class="jxr_linenumber" name="L253" href="#L253">253</a> fileSet, +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion() +<a class="jxr_linenumber" name="L255" href="#L255">255</a> ); +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (!checkInResult.isSuccess()) { +<a class="jxr_linenumber" name="L257" href="#L257">257</a> getLog().error(<span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput()); +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput() +<a class="jxr_linenumber" name="L260" href="#L260">260</a> ); +<a class="jxr_linenumber" name="L261" href="#L261">261</a> } +<a class="jxr_linenumber" name="L262" href="#L262">262</a> getLog().info(<span class="jxr_string">"Committed revision "</span> + checkInResult.getScmRevision()); +<a class="jxr_linenumber" name="L263" href="#L263">263</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L264" href="#L264">264</a> getLog().info(<span class="jxr_string">"[Dry run] Would have committed to: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L265" href="#L265">265</a> getLog().info( +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <span class="jxr_string">"[Dry run] Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); +<a class="jxr_linenumber" name="L267" href="#L267">267</a> } +<a class="jxr_linenumber" name="L268" href="#L268">268</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> ScmException e) { +<a class="jxr_linenumber" name="L269" href="#L269">269</a> getLog().error(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); +<a class="jxr_linenumber" name="L271" href="#L271">271</a> } +<a class="jxr_linenumber" name="L272" href="#L272">272</a> } +<a class="jxr_linenumber" name="L273" href="#L273">273</a> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * Lists all directories and files to a flat list.</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * @param directory {@link File} containing directory to list</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * @param files a {@link List} of {@link File} to which to append the files.</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> listNotHiddenFilesAndDirectories(<strong class="jxr_keyword">final</strong> File directory, <strong class="jxr_keyword">final</strong> List<File> files) { +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_comment">// Get all the files and directories from a directory.</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">final</strong> File[] fList = directory.listFiles(); +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> File file : fList) { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">if</strong> (file.isFile() && !file.isHidden()) { +<a class="jxr_linenumber" name="L284" href="#L284">284</a> files.add(file); +<a class="jxr_linenumber" name="L285" href="#L285">285</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.isDirectory() && !file.isHidden()) { +<a class="jxr_linenumber" name="L286" href="#L286">286</a> files.add(file); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> listNotHiddenFilesAndDirectories(file, files); +<a class="jxr_linenumber" name="L288" href="#L288">288</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> } +<a class="jxr_linenumber" name="L290" href="#L290">290</a> } +<a class="jxr_linenumber" name="L291" href="#L291">291</a> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @return the RELEASE-NOTES.txt file that exists in the <code>target/commons-release-notes/scm</code></em> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * directory for the purpose of adding it to the scm change set in the method</em> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * {@link CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,</em> +<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * ScmProvider, ScmRepository)}.</em> +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs as a wrapper so that maven</em> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * can properly handle the exception.</em> +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">private</strong> File copyReleaseNotesToWorkingDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L304" href="#L304">304</a> SharedFunctions.initDirectory(getLog(), distRcVersionDirectory); +<a class="jxr_linenumber" name="L305" href="#L305">305</a> getLog().info(<span class="jxr_string">"Copying RELEASE-NOTES.txt to working directory."</span>); +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">final</strong> File copiedReleaseNotes = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, releaseNotesFile.getName()); +<a class="jxr_linenumber" name="L307" href="#L307">307</a> SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">return</strong> copiedReleaseNotes; +<a class="jxr_linenumber" name="L309" href="#L309">309</a> } +<a class="jxr_linenumber" name="L310" href="#L310">310</a> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into</em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * the directory structure of the distribution staging repository. Specifically:</em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * <li>root:</em> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * <li>site</li></em> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * <li>site.zip</li></em> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * <li>RELEASE-NOTES.txt</li></em> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * <li>source:</em> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * <li>-src artifacts....</li></em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * <li>binaries:</em> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * <li>-bin artifacts....</li></em> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @param copiedReleaseNotes is the RELEASE-NOTES.txt file that exists in the</em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * <code>target/commons-release-plugin/scm</code> directory.</em> +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @param provider is the {@link ScmProvider} that we will use for adding the files we wish to commit.</em> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @param repository is the {@link ScmRepository} that we will use for adding the files that we wish to commit.</em> +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven</em> +<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * {@link ScmFileSet}.</em> +<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs so that Maven can handle it properly.</em> +<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">private</strong> List<File> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(<strong class="jxr_keyword">final</strong> File copiedReleaseNotes, +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">final</strong> ScmProvider provider, +<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">final</strong> ScmRepository repository) +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">final</strong> List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles()); +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">final</strong> List<File> filesForMavenScmFileSet = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">final</strong> File scmBinariesRoot = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, <span class="jxr_string">"binaries"</span>); +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">final</strong> File scmSourceRoot = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, <span class="jxr_string">"source"</span>); +<a class="jxr_linenumber" name="L350" href="#L350">350</a> SharedFunctions.initDirectory(getLog(), scmBinariesRoot); +<a class="jxr_linenumber" name="L351" href="#L351">351</a> SharedFunctions.initDirectory(getLog(), scmSourceRoot); +<a class="jxr_linenumber" name="L352" href="#L352">352</a> File copy; +<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> File file : workingDirectoryFiles) { +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"src"</span>)) { +<a class="jxr_linenumber" name="L355" href="#L355">355</a> copy = <strong class="jxr_keyword">new</strong> File(scmSourceRoot, file.getName()); +<a class="jxr_linenumber" name="L356" href="#L356">356</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L357" href="#L357">357</a> filesForMavenScmFileSet.add(file); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"bin"</span>)) { +<a class="jxr_linenumber" name="L359" href="#L359">359</a> copy = <strong class="jxr_keyword">new</strong> File(scmBinariesRoot, file.getName()); +<a class="jxr_linenumber" name="L360" href="#L360">360</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L361" href="#L361">361</a> filesForMavenScmFileSet.add(file); +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (StringUtils.containsAny(file.getName(), <span class="jxr_string">"scm"</span>, <span class="jxr_string">"sha256.properties"</span>, <span class="jxr_string">"sha512.properties"</span>)) { +<a class="jxr_linenumber" name="L363" href="#L363">363</a> getLog().debug(<span class="jxr_string">"Not copying scm directory over to the scm directory because it is the scm directory."</span>); +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_comment">//do nothing because we are copying into scm</em> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L366" href="#L366">366</a> copy = <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory.getAbsolutePath(), file.getName()); +<a class="jxr_linenumber" name="L367" href="#L367">367</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L368" href="#L368">368</a> filesForMavenScmFileSet.add(file); +<a class="jxr_linenumber" name="L369" href="#L369">369</a> } +<a class="jxr_linenumber" name="L370" href="#L370">370</a> } +<a class="jxr_linenumber" name="L371" href="#L371">371</a> filesForMavenScmFileSet.addAll(buildReadmeAndHeaderHtmlFiles()); +<a class="jxr_linenumber" name="L372" href="#L372">372</a> filesForMavenScmFileSet.add(copySignatureValidatorScriptToScmDirectory()); +<a class="jxr_linenumber" name="L373" href="#L373">373</a> filesForMavenScmFileSet.addAll(copySiteToScmDirectory()); +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">return</strong> filesForMavenScmFileSet; +<a class="jxr_linenumber" name="L375" href="#L375">375</a> } +<a class="jxr_linenumber" name="L376" href="#L376">376</a> +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * Copies our <code>signature-validator.sh</code> script into</em> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * <code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</em> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * @return the {@link File} for the signature-validator.sh</em> +<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an error occurs while the resource is being copied</em> +<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">private</strong> File copySignatureValidatorScriptToScmDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">final</strong> Path scmTargetPath = Paths.get(distRcVersionDirectory.toString(), SIGNATURE_VALIDATOR_NAME); +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">final</strong> String name = <span class="jxr_string">"/resources/"</span> + SIGNATURE_VALIDATOR_NAME; +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_comment">// The source can be in a local file or inside a jar file.</em> +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L389" href="#L389">389</a> PathUtils.copyFile(getClass().getResource(name), scmTargetPath); +<a class="jxr_linenumber" name="L390" href="#L390">390</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) { +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(String.format(<span class="jxr_string">"Failed to copy '%s' to '%s'"</span>, name, scmTargetPath), e); +<a class="jxr_linenumber" name="L392" href="#L392">392</a> } +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">return</strong> scmTargetPath.toFile(); +<a class="jxr_linenumber" name="L394" href="#L394">394</a> } +<a class="jxr_linenumber" name="L395" href="#L395">395</a> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</em> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * @return the {@link List} of {@link File}'s contained in</em> +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * <code>${basedir}/target/commons-release-plugin/scm/site</code>, after the copy is complete.</em> +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the site copying fails for some reason.</em> +<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">private</strong> List<File> copySiteToScmDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong class="jxr_keyword">if</strong> (!siteDirectory.exists()) { +<a class="jxr_linenumber" name="L405" href="#L405">405</a> getLog().error(<span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span>); +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L407" href="#L407">407</a> <span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> +<a class="jxr_linenumber" name="L408" href="#L408">408</a> ); +<a class="jxr_linenumber" name="L409" href="#L409">409</a> } +<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">final</strong> File siteInScm = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, <span class="jxr_string">"site"</span>); +<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L412" href="#L412">412</a> FileUtils.copyDirectory(siteDirectory, siteInScm); +<a class="jxr_linenumber" name="L413" href="#L413">413</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Site copying failed"</span>, e); +<a class="jxr_linenumber" name="L415" href="#L415">415</a> } +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ArrayList<>(FileUtils.listFiles(siteInScm, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">true</strong>)); +<a class="jxr_linenumber" name="L417" href="#L417">417</a> } +<a class="jxr_linenumber" name="L418" href="#L418">418</a> +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</em> +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * <li>distRoot</em> +<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> * <li>binaries/HEADER.html (symlink)</li></em> +<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> * <li>binaries/README.html (symlink)</li></em> +<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> * <li>source/HEADER.html (symlink)</li></em> +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * <li>source/README.html (symlink)</li></em> +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * <li>HEADER.html</li></em> +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * <li>README.html</li></em> +<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * </li></em> +<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * @return the {@link List} of created files above</em> +<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs in the creation of these</em> +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * files fails.</em> +<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">private</strong> List<File> buildReadmeAndHeaderHtmlFiles() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">final</strong> List<File> headerAndReadmeFiles = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">final</strong> File headerFile = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, HEADER_FILE_NAME); +<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_comment">// HEADER file</em> +<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">try</strong> (Writer headerWriter = <strong class="jxr_keyword">new</strong> OutputStreamWriter(Files.newOutputStream(headerFile.toPath()), +<a class="jxr_linenumber" name="L444" href="#L444">444</a> StandardCharsets.UTF_8)) { +<a class="jxr_linenumber" name="L445" href="#L445">445</a> HeaderHtmlVelocityDelegate.builder().build().render(headerWriter); +<a class="jxr_linenumber" name="L446" href="#L446">446</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"Could not build HEADER html file "</span> + headerFile; +<a class="jxr_linenumber" name="L448" href="#L448">448</a> getLog().error(message, e); +<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); +<a class="jxr_linenumber" name="L450" href="#L450">450</a> } +<a class="jxr_linenumber" name="L451" href="#L451">451</a> headerAndReadmeFiles.add(headerFile); +<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_comment">// README file</em> +<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">final</strong> File readmeFile = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, README_FILE_NAME); +<a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">try</strong> (Writer readmeWriter = <strong class="jxr_keyword">new</strong> OutputStreamWriter(Files.newOutputStream(readmeFile.toPath()), +<a class="jxr_linenumber" name="L457" href="#L457">457</a> StandardCharsets.UTF_8)) { +<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_comment">// @formatter:off</em> +<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">final</strong> <a name="ReadmeHtmlVelocityDelegate" href="../../../../../../org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#ReadmeHtmlVelocityDelegate">ReadmeHtmlVelocityDelegate</a> readmeHtmlVelocityDelegate = ReadmeHtmlVelocityDelegate.builder() +<a class="jxr_linenumber" name="L460" href="#L460">460</a> .withArtifactId(project.getArtifactId()) +<a class="jxr_linenumber" name="L461" href="#L461">461</a> .withVersion(project.getVersion()) +<a class="jxr_linenumber" name="L462" href="#L462">462</a> .withSiteUrl(project.getUrl()) +<a class="jxr_linenumber" name="L463" href="#L463">463</a> .build(); +<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_comment">// @formatter:on</em> +<a class="jxr_linenumber" name="L465" href="#L465">465</a> readmeHtmlVelocityDelegate.render(readmeWriter); +<a class="jxr_linenumber" name="L466" href="#L466">466</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">final</strong> String message = <span class="jxr_string">"Could not build README html file "</span> + readmeFile; +<a class="jxr_linenumber" name="L468" href="#L468">468</a> getLog().error(message, e); +<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); +<a class="jxr_linenumber" name="L470" href="#L470">470</a> } +<a class="jxr_linenumber" name="L471" href="#L471">471</a> headerAndReadmeFiles.add(readmeFile); +<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_comment">// signature-validator.sh file copy</em> +<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L475" href="#L475">475</a> headerAndReadmeFiles.addAll(copyHeaderAndReadmeToSubdirectories(headerFile, readmeFile)); +<a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">return</strong> headerAndReadmeFiles; +<a class="jxr_linenumber" name="L477" href="#L477">477</a> } +<a class="jxr_linenumber" name="L478" href="#L478">478</a> +<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries</em> +<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> * directories.</em> +<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> * @param headerFile The originally created <code>HEADER.html</code> file.</em> +<a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> * @param readmeFile The originally created <code>README.html</code> file.</em> +<a class="jxr_linenumber" name="L485" href="#L485">485</a> <em class="jxr_javadoccomment"> * @return a {@link List} of created files.</em> +<a class="jxr_linenumber" name="L486" href="#L486">486</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the {@link SharedFunctions#copyFile(Log, File, File)}</em> +<a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment"> * fails.</em> +<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">private</strong> List<File> copyHeaderAndReadmeToSubdirectories(<strong class="jxr_keyword">final</strong> File headerFile, <strong class="jxr_keyword">final</strong> File readmeFile) +<a class="jxr_linenumber" name="L490" href="#L490">490</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">final</strong> List<File> symbolicLinkFiles = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L492" href="#L492">492</a> <strong class="jxr_keyword">final</strong> File sourceRoot = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, <span class="jxr_string">"source"</span>); +<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">final</strong> File binariesRoot = <strong class="jxr_keyword">new</strong> File(distRcVersionDirectory, <span class="jxr_string">"binaries"</span>); +<a class="jxr_linenumber" name="L494" href="#L494">494</a> <strong class="jxr_keyword">final</strong> File sourceHeaderFile = <strong class="jxr_keyword">new</strong> File(sourceRoot, HEADER_FILE_NAME); +<a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">final</strong> File sourceReadmeFile = <strong class="jxr_keyword">new</strong> File(sourceRoot, README_FILE_NAME); +<a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">final</strong> File binariesHeaderFile = <strong class="jxr_keyword">new</strong> File(binariesRoot, HEADER_FILE_NAME); +<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong class="jxr_keyword">final</strong> File binariesReadmeFile = <strong class="jxr_keyword">new</strong> File(binariesRoot, README_FILE_NAME); +<a class="jxr_linenumber" name="L498" href="#L498">498</a> SharedFunctions.copyFile(getLog(), headerFile, sourceHeaderFile); +<a class="jxr_linenumber" name="L499" href="#L499">499</a> symbolicLinkFiles.add(sourceHeaderFile); +<a class="jxr_linenumber" name="L500" href="#L500">500</a> SharedFunctions.copyFile(getLog(), readmeFile, sourceReadmeFile); +<a class="jxr_linenumber" name="L501" href="#L501">501</a> symbolicLinkFiles.add(sourceReadmeFile); +<a class="jxr_linenumber" name="L502" href="#L502">502</a> SharedFunctions.copyFile(getLog(), headerFile, binariesHeaderFile); +<a class="jxr_linenumber" name="L503" href="#L503">503</a> symbolicLinkFiles.add(binariesHeaderFile); +<a class="jxr_linenumber" name="L504" href="#L504">504</a> SharedFunctions.copyFile(getLog(), readmeFile, binariesReadmeFile); +<a class="jxr_linenumber" name="L505" href="#L505">505</a> symbolicLinkFiles.add(binariesReadmeFile); +<a class="jxr_linenumber" name="L506" href="#L506">506</a> <strong class="jxr_keyword">return</strong> symbolicLinkFiles; +<a class="jxr_linenumber" name="L507" href="#L507">507</a> } +<a class="jxr_linenumber" name="L508" href="#L508">508</a> +<a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment"> * This method is the setter for the {@link CommonsDistributionStagingMojo#baseDir} field, specifically</em> +<a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> * for the usage in the unit tests.</em> +<a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * @param baseDir is the {@link File} to be used as the project's root directory when this mojo</em> +<a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> * is invoked.</em> +<a class="jxr_linenumber" name="L515" href="#L515">515</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L516" href="#L516">516</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setBaseDir(<strong class="jxr_keyword">final</strong> File baseDir) { +<a class="jxr_linenumber" name="L517" href="#L517">517</a> <strong class="jxr_keyword">this</strong>.baseDir = baseDir; +<a class="jxr_linenumber" name="L518" href="#L518">518</a> } +<a class="jxr_linenumber" name="L519" href="#L519">519</a> } +</pre> +<hr/> +<div id="footer">© 2018?2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a></div> +</body> +</html>
