You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by hb...@apache.org on 2018/01/25 22:55:21 UTC

svn commit: r1024323 - in /websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST: index.html various-tips.html

Author: hboutemy
Date: Thu Jan 25 22:55:21 2018
New Revision: 1024323

Log:
Site checkin for project Apache Maven SCM Publish Plugin

Modified:
    websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/index.html
    websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/various-tips.html

Modified: websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/index.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/index.html (original)
+++ websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/index.html Thu Jan 25 22:55:21 2018
@@ -125,7 +125,7 @@
 <h2><a name="Apache_Maven_SCM_Publish_Plugin"></a>Apache Maven SCM Publish Plugin</h2>
 <p>The maven-scm-publish-plugin is a utility plugin to allow publishing Maven website to any supported SCM. The primary goal was to have an utility plugin to allow Apache projects to publish Maven websites via the ASF svnpubsub system.</p>
 <p>In addition to SCM operations, it takes care to fix newline inconsistencies generated by <tt>maven-site-plugin</tt> (see <a class="externalLink" href="https://issues.apache.org/jira/browse/MSITE-121">MSITE-121</a>), which prevents simple content import to SCM.</p>
-<p>The plugin has been tested with git scm too and by example can push content for github pages.</p>
+<p>The plugin has been tested with git scm too and by example can <a href="./various-tips.html#Git_branch">push content for GitHub pages</a>.</p>
 <div class="section">
 <h3><a name="Implementation"></a>Implementation</h3>
 <p>The plugin works from staged website by default (see <a href="./publish-scm-mojo.html#content"><tt>content</tt> parameter</a>).</p>
@@ -144,14 +144,14 @@
 <h3><a name="Known_Limitations"></a>Known Limitations</h3>
 <p>There are 2 known limitations:</p>
 <ul>
-<li>for svn, the plugin can create the initial SCM directory if it does not exist. But for git by example, if you use a branch, the branch won't be created: you have to create it manually,</li>
+<li>for Subversion, the plugin can create the initial SCM directory if it does not exist. But for Git by example, if you use a branch, the branch won't be created: you have to <a href="./various-tips.html#Git_branch">create it manually</a>,</li>
 <li>the plugin works well for multi-module websites publishing to a complete directory: you just need to publish <tt>mvn site:stage</tt> content. But if one module does not publish its content to the same directory (like Surefire or Enforcer, which have a base directory and one plugin in <tt>/plugins/</tt>), this staging area can't be simply imported.</li></ul></div>
 <div class="section">
 <h3><a name="Future_Dreams"></a>Future Dreams</h3>
 <p>Ideally, scm urls would be supported in <tt>&lt;distributionManagement</tt>&gt; section of the POM, then publishing would simply be <tt>mvn site-deploy</tt>, without any problems for non-flat multi-modules sites.</p>
 <p>To reach such a dream, there are some steps:</p>
 <ul>
-<li>fix inconsistent newlines generated by <tt>maven-site-plugin</tt> (caused by <tt>site.vm</tt> template and resources taken from skin jar without fixing newlines): <a class="externalLink" href="https://issues.apache.org/jira/browse/MSITE-121">MSITE-121</a> is fixed in (future) maven-site-plugin 3.4,</li>
+<li>fix inconsistent newlines generated by <tt>maven-site-plugin</tt> (caused by <tt>site.vm</tt> template and resources taken from skin jar without fixing newlines): <a class="externalLink" href="https://issues.apache.org/jira/browse/MSITE-121">MSITE-121</a> is fixed in maven-site-plugin 3.4,</li>
 <li>improve <a href="/wagon/wagon-providers/wagon-scm/"><tt>wagon-scm</tt></a> to put a whole directory content in one commit, and not with one commit per file.</li></ul>
 <p>Then this plugin would be outdated, replaced by natural <tt>maven-site-plugin:deploy</tt> goal.</p></div></div>
         </div>

Modified: websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/various-tips.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/various-tips.html (original)
+++ websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST/various-tips.html Thu Jan 25 22:55:21 2018
@@ -137,12 +137,11 @@
         &lt;scmBranch&gt;gh-pages&lt;/scmBranch&gt;
       &lt;/configuration&gt;
     &lt;/plugin&gt;</pre></div>
-<p>Initial creation of the branch has to be done manually, as a Git orphan branch:</p>
-<ul>
-<li><tt>git checkout --orphan gh-pages</tt> to create the branch locally,</li>
-<li><tt>rm .git/index ; git clean -fdx</tt> to clean the branch content and let it empy,</li>
-<li>copy an initial site content,</li>
-<li>commit and push: <tt>git add *</tt>, <tt>git commit -m &quot;initial site content&quot;</tt>, <tt>git push</tt></li></ul></div>
+<p><b>Initial creation of the branch has to be done manually</b>, as a Git orphan branch:</p>
+<p>1. <tt>git checkout --orphan gh-pages</tt> to create the branch locally,</p>
+<p>2. <tt>rm .git/index ; git clean -fdx</tt> to clean the branch content and let it empy,</p>
+<p>3. copy an initial site content,</p>
+<p>4. commit and push: <tt>git add *</tt>, <tt>git commit -m &quot;initial site content&quot;</tt>, <tt>git push</tt></p></div>
 <div class="section">
 <h3><a name="Improving_SCM_Checkout_Performance"></a>Improving SCM Checkout Performance</h3>
 <p>By default, a complete checkout is done. You can configure the plugin to try update rather than a full checkout/clone</p>