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:43:44 UTC
svn commit: r1024321 [12/12] - in
/websites/production/maven/components/plugins-archives/maven-scm-publish-plugin-LATEST:
./ apidocs/ css/ examples/ fonts/ images/ images/profiles/ img/ js/ xref/
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:43:43 2018
@@ -1,184 +1,118 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-05-18
- | Rendered using Apache Maven Stylus Skin 1.5
+ | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/apt/various-tips.apt.vm at 2018-01-25
+ | Rendered using Apache Maven Fluido Skin 1.7
-->
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Apache Maven SCM Publish Plugin - Various Tips</title>
- <style type="text/css" media="all">
- @import url("./css/maven-base.css");
- @import url("./css/maven-theme.css");
- @import url("./css/site.css");
- </style>
- <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="author" content="Olivier Lamy" />
- <meta name="Date-Creation-yyyymmdd" content="20120904" />
- <meta name="Date-Revision-yyyymmdd" content="20140518" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../" id="bannerLeft">
- <img src="../../images/apache-maven-project-2.png" alt="" />
- </a>
- <span id="bannerRight">
- <img src="../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Olivier Lamy" />
+ <meta name="Date-Creation-yyyymmdd" content="20120904" />
+ <meta name="Date-Revision-yyyymmdd" content="20180125" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Maven SCM Publish Plugin – Various Tips</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven SCM Publish Plugin"/></a></div>
+ <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div>
+ <div class="clear"><hr/></div>
</div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../index.html">Maven</a>
- >
- <a href="../index.html">Plugins</a>
- >
- <a href="./">Apache Maven SCM Publish Plugin</a>
- >
- Various Tips
- </div>
- <div class="xright">
- Last Published: 2014-05-18
- | Version: 1.1
- </div>
- <div class="clear">
- <hr/>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
+ <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
+ <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li>
+ <li class=""><a href="index.html" title="Apache Maven SCM Publish Plugin">Apache Maven SCM Publish Plugin</a><span class="divider">/</span></li>
+ <li class="active ">Various Tips <a href="https://github.com/apache/maven-scm-publish-plugin/tree/HEAD/src/site/apt/various-tips.apt.vm"><img src="./images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-25</li>
+ <li id="projectVersion" class="pull-right">Version: 1.2-SNAPSHOT</li>
+ </ul>
</div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>Overview</h5>
- <ul>
- <li class="none">
- <a href="index.html">Introduction</a>
- </li>
- <li class="none">
- <a href="plugin-info.html">Goals</a>
- </li>
- <li class="none">
- <a href="usage.html">Usage</a>
- </li>
- <li class="none">
- <strong>Some Tips</strong>
- </li>
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
- <li class="none">
- <a href="download.html">Download</a>
- </li>
- </ul>
- <h5>Example</h5>
- <ul>
- <li class="none">
- <a href="examples/one-module-configuration.html">Maven Mono Module Configuration</a>
- </li>
- <li class="none">
- <a href="examples/multi-module-configuration.html">Maven Multi module Configuration</a>
- </li>
- <li class="none">
- <a href="examples/importing-maven-site.html">Importing Maven sites</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="project-info.html">Project Information</a>
- </li>
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
- </li>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../../doxia/index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../maven-1.x/index.html">Maven 1.x</a>
- </li>
- <li class="none">
- <a href="../../index.html">Maven 2 & 3</a>
- </li>
- <li class="none">
- <a href="../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="./images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt-
format.html --><div class="section">
-<h2>Various tips for using this plugin<a name="Various_tips_for_using_this_plugin"></a></h2>
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li>
+ <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Some Tips</a></li>
+ <li><a href="http://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li>
+ <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li>
+ <li class="nav-header">Example</li>
+ <li><a href="examples/one-module-configuration.html" title="Maven Mono Module Configuration"><span class="none"></span>Maven Mono Module Configuration</a></li>
+ <li><a href="examples/multi-module-configuration.html" title="Maven Multi module Configuration"><span class="none"></span>Maven Multi module Configuration</a></li>
+ <li><a href="examples/importing-maven-site.html" title="Importing Maven sites"><span class="none"></span>Importing Maven sites</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+ <li class="nav-header">Maven Projects</li>
+ <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li>
+ <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li>
+ <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li>
+ <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li>
+ <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li>
+ <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li>
+ <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li>
+ <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li>
+ <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li>
+ <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li>
+ <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li>
+ <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li>
+ <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li>
+ <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li>
+ <li class="nav-header">ASF</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li>
+ <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li>
+</ul>
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="$sitesearchValue" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <hr />
+ <div id="poweredBy">
+ <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script>
+ <div class="g-plusone" data-href="https://maven.apache.org/plugins/maven-scm-publish-plugin/" data-size="tall" ></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </div>
+ <div id="bodyColumn" class="span10" >
<div class="section">
-<h3>URL format<a name="URL_format"></a></h3>
+<h2><a name="Various_tips_for_using_this_plugin"></a>Various tips for using this plugin</h2>
+<div class="section">
+<h3><a name="URL_format"></a>URL format</h3>
<p>You must use a scm url format:</p>
-<div class="source">
-<pre> scm:<scm_provider><delimiter><provider_specific_part></pre></div>
+<div class="source"><pre class="prettyprint linenums"> scm:<scm_provider><delimiter><provider_specific_part></pre></div>
<p>Example for svn: <tt>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin/</tt></p>
<p>And configure is as it:</p>
-<div class="source">
-<pre> <distributionManagement>
+<div class="source"><pre class="prettyprint linenums"> <distributionManagement>
<site>
<id>site_id</id>
<url>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin/</url>
@@ -186,39 +120,42 @@
</distributionManagement></pre></div>
<p><b>NOTE</b>: with svn, if the remote url doesn't exist, it will be created.</p></div>
<div class="section">
-<h3>Git branch<a name="Git_branch"></a></h3>
-<p>To use git branch (for example: github gh-pages)</p>
-<div class="source">
-<pre> <distributionManagement>
+<h3><a name="Git_branch"></a>Git branch</h3>
+<p>To use Git branch (for example: <a class="externalLink" href="https://help.github.com/articles/user-organization-and-project-pages/">GitHub <tt>gh-pages</tt></a>)</p>
+<div class="source"><pre class="prettyprint linenums"> <distributionManagement>
<site>
<id>site_id</id>
- <url>scm:git:git@github.com:username/tomcat-foo-artifact.git</url>
+ <url>scm:git:ssh://git@github.com/username/tomcat-foo-artifact.git</url><!-- or scm:git:https://gitbox.apache.org/repos/asf/maven-scm-publish-plugin.git -->
</site>
</distributionManagement>
...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
- <version>1.1</version>
+ <version>1.2-SNAPSHOT</version>
<configuration>
<scmBranch>gh-pages</scmBranch>
</configuration>
- </plugin></pre></div></div>
+ </plugin></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 "initial site content"</tt>, <tt>git push</tt></li></ul></div>
<div class="section">
-<h3>Improving SCM Checkout Performance<a name="Improving_SCM_Checkout_Performance"></a></h3>
+<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>
-<div class="source">
-<pre> <plugin>
+<div class="source"><pre class="prettyprint linenums"> <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
- <version>1.1</version>
+ <version>1.2-SNAPSHOT</version>
<configuration>
<tryUpdate>true</tryUpdate>
</configuration>
</plugin></pre></div>
<p>By default, the scm content is checked-out/cloned to <tt>${project.build.directory}/scmpublish-checkout</tt>, so when running <tt>mvn clean</tt>, all the content is deleted. You can configure a path to your machine to avoid full checkout. A recommended way is to use a property with a default value that your colleague will be able to override in their settings.</p>
-<div class="source">
-<pre> <properties>
+<div class="source"><pre class="prettyprint linenums"> <properties>
...
<!-- override in your settings -->
<siteMainDirectory>${user.home}</siteMainDirectory>
@@ -229,20 +166,19 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
- <version>1.1</version>
+ <version>1.2-SNAPSHOT</version>
<configuration>
<checkoutDirectory>${scmPubCheckoutDirectory}</checkoutDirectory>
<tryUpdate>true</tryUpdate>
</configuration>
</plugin></pre></div></div>
<div class="section">
-<h3>Using alternate scm provider<a name="Using_alternate_scm_provider"></a></h3>
+<h3><a name="Using_alternate_scm_provider"></a>Using alternate scm provider</h3>
<p>You can use svnjava rather than default svn cli if you use a machine without svn cli.</p>
-<div class="source">
-<pre> <plugin>
+<div class="source"><pre class="prettyprint linenums"> <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
- <version>1.1</version>
+ <version>1.2-SNAPSHOT</version>
<configuration>
<providerImplementations>
<svn>javasvn</svn>
@@ -261,22 +197,18 @@
</dependency>
</dependencies>
</plugin></pre></div></div></div>
+ </div>
</div>
</div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2002-2014
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2002–2018
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
</div>
- </div>
+ </footer>
</body>
</html>
\ No newline at end of file