Modified: maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/publish-scm-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/publish-scm-mojo.html (original) +++ maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/publish-scm-mojo.html Sun Mar 26 17:47:20 2023 @@ -1,808 +1,755 @@ -<!DOCTYPE html> -<!-- - | Generated by Apache Maven Doxia Site Renderer 1.8.1 from target/generated-site/xdoc/publish-scm-mojo.xml at 2020-12-23 - | Rendered using Apache Maven Fluido Skin 1.7 ---> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> - <head> - <meta charset="UTF-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20201223" /> - <meta http-equiv="Content-Language" content="en" /> - <title>Apache Maven SCM Publish Plugin – scm-publish:publish-scm</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 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 ">scm-publish:publish-scm</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2020-12-23</li> - <li id="projectVersion" class="pull-right">Version: 3.1.0</li> - </ul> - </div> - <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><a href="various-tips.html" title="Some Tips"><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="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</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="maven.apache.org/plugins/maven-scm-publish-plugin/" 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"> - <div class="clear"></div> - <div class="clear"></div> - <div id="twitter"> - <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> - <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </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"> -<h2><a name="scm-publish:publish-scm"></a>scm-publish:publish-scm</h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.maven.plugins:maven-scm-publish-plugin:3.1.0:publish-scm</p> - -<p><b>Description</b>:</p> - -<div>Publish a content to scm. By default, content is taken from default -site staging directory -<tt>${project.build.directory}/staging</tt>. Can be used -without project, so usable to update any SCM with any content.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>Executes as an aggregator plugin.</li> - </ul> - -<div class="section"> -<h3><a name="Required_Parameters"></a>Required Parameters</h3> - -<table class="table table-striped" border="0"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><tt><a href="#pubScmUrl"><pubScmUrl></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Location of the scm publication tree: -<tt>scm:<scm_provider><delimiter><provider_specific_part></tt>. -Example: -<tt>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</tt><br /><b>Default value is</b>: <tt>${project.distributionManagement.site.url}</tt>.<br /><b>User property is</b>: <tt>scmpublish.pubScmUrl</tt>.<br /></td> - </tr> - </table> - </div> - -<div class="section"> -<h3><a name="Optional_Parameters"></a>Optional Parameters</h3> - -<table class="table table-striped" border="0"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><tt><a href="#addUniqueDirectory"><addUniqueDirectory></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Add each directory in a separated SCM command: this can be -necessary if SCM does not support adding subdirectories in one -command.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#automaticRemotePathCreation"><automaticRemotePathCreation></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Configure svn automatic remote url creation.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>scmpublish.automaticRemotePathCreation</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#checkinComment"><checkinComment></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>SCM log/checkin comment for this publication.<br /><b>Default value is</b>: <tt>Site checkin for project ${project.name}</tt>.<br /><b>User property is</b>: <tt>scmpublish.checkinComment</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#checkoutDirectory"><checkoutDirectory></a></tt></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>Location where the scm check-out is done. By default, scm checkout -is done in build (target) directory, which is deleted on every -<tt>mvn clean</tt>. To avoid this and get better performance, -configure this location outside build structure and set -<tt>tryUpdate</tt> to <tt>true</tt>. See <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html#Improving_SCM_Checkout_Performance";>Improving -SCM Checkout Performance</a> for more information.<br /><b>Default value is</b>: <tt>${project.build.directory}/scmpublish-checkout</tt>.<br /><b>User property is</b>: <tt>scmpublish.checkoutDirectory</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#content"><content></a></tt></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>The content to be published.<br /><b>Default value is</b>: <tt>${project.build.directory}/staging</tt>.<br /><b>User property is</b>: <tt>scmpublish.content</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#dryRun"><dryRun></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Display list of added, deleted, and changed files, but do not do -any actual SCM operations.<br /><b>User property is</b>: <tt>scmpublish.dryRun</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#excludes"><excludes></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Patterns to exclude from the scm tree.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#extraNormalizeExtensions"><extraNormalizeExtensions></a></tt></td> - -<td><tt>String[]</tt></td> - -<td><tt>-</tt></td> - -<td>Extra file extensions to normalize line ending (will be added to -default <tt>html</tt>,<tt>css</tt>,<tt>js</tt> list)<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#ignorePathsToDelete"><ignorePathsToDelete></a></tt></td> - -<td><tt>String[]</tt></td> - -<td><tt>-</tt></td> - -<td>Collections of paths not to delete when checking content to delete. -If your site has subdirectories published by an other -mechanism/build<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#includes"><includes></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Patterns to include in the scm tree.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#localCheckout"><localCheckout></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Use a local checkout instead of doing a checkout from the upstream -repository. <b>WARNING</b>: This will only work with distributed -SCMs which support the file:// protocol. TODO: we should think -about having the defaults for the various SCM providers provided -via Modello!<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>localCheckout</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#password"><password></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>The SCM password to use.<br /><b>User property is</b>: <tt>password</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#providerImplementations"><providerImplementations></a></tt></td> - -<td><tt>Map</tt></td> - -<td><tt>-</tt></td> - -<td>List of SCM provider implementations. Key is the provider type, eg. -<tt>cvs</tt>. Value is the provider implementation (the -role-hint of the provider), eg. <tt>cvs</tt> or -<tt>cvs_native</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#scmBranch"><scmBranch></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>SCM branch to use. For github, you must configure with -<tt>gh-pages</tt>.<br /><b>User property is</b>: <tt>scmpublish.scm.branch</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#serverId"><serverId></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>The serverId specified in the settings.xml, which should be used -for the authentication.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#siteOutputEncoding"><siteOutputEncoding></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>The outputEncoding parameter of the site plugin. This plugin will -corrupt your site if this does not match the value used by the site -plugin.<br /><b>Default value is</b>: <tt>${project.reporting.outputEncoding}</tt>.<br /><b>User property is</b>: <tt>outputEncoding</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#skipCheckin"><skipCheckin></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Run add and delete commands, but leave the actually checkin for the -user to run manually.<br /><b>User property is</b>: <tt>scmpublish.skipCheckin</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#skipDeletedFiles"><skipDeletedFiles></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Do not delete files to the scm<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>scmpublish.skipDeletedFiles</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#skipDeployement"><skipDeployement></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Set this to 'true' to skip site deployment.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>scmpublish.skipDeploy</tt>.<br /><b>Alias is</b>: <tt>maven.site.deploy.skip</tt>.</td> - </tr> - -<tr class="a"> - -<td><tt><a href="#subDirectory"><subDirectory></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Location where the content is published inside the -<tt>${checkoutDirectory}</tt>. By default, content is copyed at -the root of <tt>${checkoutDirectory}</tt>.<br /><b>User property is</b>: <tt>scmpublish.subDirectory</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#tryUpdate"><tryUpdate></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>If the checkout directory exists and this flag is activated, the -plugin will try an SCM-update instead of delete then checkout.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>scmpublish.tryUpdate</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#username"><username></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>The SCM username to use.<br /><b>User property is</b>: <tt>username</tt>.<br /></td> - </tr> - </table> - </div> - -<div class="section"> -<h3><a name="Parameter_Details"></a>Parameter Details</h3> - -<div class="section"> -<h4><a name="a.3CaddUniqueDirectory.3E"></a><b><a name="addUniqueDirectory"><addUniqueDirectory></a></b></h4> - -<div>Add each directory in a separated SCM command: this can be -necessary if SCM does not support adding subdirectories in one -command.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CautomaticRemotePathCreation.3E"></a><b><a name="automaticRemotePathCreation"><automaticRemotePathCreation></a></b></h4> - -<div>Configure svn automatic remote url creation.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.automaticRemotePathCreation</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CcheckinComment.3E"></a><b><a name="checkinComment"><checkinComment></a></b></h4> - -<div>SCM log/checkin comment for this publication.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.checkinComment</tt></li> - -<li><b>Default</b>: <tt>Site checkin for project ${project.name}</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CcheckoutDirectory.3E"></a><b><a name="checkoutDirectory"><checkoutDirectory></a></b></h4> - -<div>Location where the scm check-out is done. By default, scm checkout -is done in build (target) directory, which is deleted on every -<tt>mvn clean</tt>. To avoid this and get better performance, -configure this location outside build structure and set -<tt>tryUpdate</tt> to <tt>true</tt>. See <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html#Improving_SCM_Checkout_Performance";>Improving -SCM Checkout Performance</a> for more information.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.checkoutDirectory</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/scmpublish-checkout</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Ccontent.3E"></a><b><a name="content"><content></a></b></h4> - -<div>The content to be published.</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.content</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/staging</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CdryRun.3E"></a><b><a name="dryRun"><dryRun></a></b></h4> - -<div>Display list of added, deleted, and changed files, but do not do -any actual SCM operations.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.dryRun</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> - -<div>Patterns to exclude from the scm tree.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CextraNormalizeExtensions.3E"></a><b><a name="extraNormalizeExtensions"><extraNormalizeExtensions></a></b></h4> - -<div>Extra file extensions to normalize line ending (will be added to -default <tt>html</tt>,<tt>css</tt>,<tt>js</tt> list)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String[]</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CignorePathsToDelete.3E"></a><b><a name="ignorePathsToDelete"><ignorePathsToDelete></a></b></h4> - -<div>Collections of paths not to delete when checking content to delete. -If your site has subdirectories published by an other -mechanism/build</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String[]</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> - -<div>Patterns to include in the scm tree.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3ClocalCheckout.3E"></a><b><a name="localCheckout"><localCheckout></a></b></h4> - -<div>Use a local checkout instead of doing a checkout from the upstream -repository. <b>WARNING</b>: This will only work with distributed -SCMs which support the file:// protocol. TODO: we should think -about having the defaults for the various SCM providers provided -via Modello!</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>localCheckout</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Cpassword.3E"></a><b><a name="password"><password></a></b></h4> - -<div>The SCM password to use.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>password</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CproviderImplementations.3E"></a><b><a name="providerImplementations"><providerImplementations></a></b></h4> - -<div>List of SCM provider implementations. Key is the provider type, eg. -<tt>cvs</tt>. Value is the provider implementation (the -role-hint of the provider), eg. <tt>cvs</tt> or -<tt>cvs_native</tt>.</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.Map</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CpubScmUrl.3E"></a><b><a name="pubScmUrl"><pubScmUrl></a></b></h4> - -<div>Location of the scm publication tree: -<tt>scm:<scm_provider><delimiter><provider_specific_part></tt>. -Example: -<tt>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</tt></div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>Yes</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.pubScmUrl</tt></li> - -<li><b>Default</b>: <tt>${project.distributionManagement.site.url}</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CscmBranch.3E"></a><b><a name="scmBranch"><scmBranch></a></b></h4> - -<div>SCM branch to use. For github, you must configure with -<tt>gh-pages</tt>.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.scm.branch</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CserverId.3E"></a><b><a name="serverId"><serverId></a></b></h4> - -<div>The serverId specified in the settings.xml, which should be used -for the authentication.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CsiteOutputEncoding.3E"></a><b><a name="siteOutputEncoding"><siteOutputEncoding></a></b></h4> - -<div>The outputEncoding parameter of the site plugin. This plugin will -corrupt your site if this does not match the value used by the site -plugin.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>outputEncoding</tt></li> - -<li><b>Default</b>: <tt>${project.reporting.outputEncoding}</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CskipCheckin.3E"></a><b><a name="skipCheckin"><skipCheckin></a></b></h4> - -<div>Run add and delete commands, but leave the actually checkin for the -user to run manually.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.skipCheckin</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CskipDeletedFiles.3E"></a><b><a name="skipDeletedFiles"><skipDeletedFiles></a></b></h4> - -<div>Do not delete files to the scm</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.skipDeletedFiles</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CskipDeployement.3E"></a><b><a name="skipDeployement"><skipDeployement></a></b></h4> - -<div>Set this to 'true' to skip site deployment.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.skipDeploy</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - -<li><b>Alias</b>: <tt>maven.site.deploy.skip</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CsubDirectory.3E"></a><b><a name="subDirectory"><subDirectory></a></b></h4> - -<div>Location where the content is published inside the -<tt>${checkoutDirectory}</tt>. By default, content is copyed at -the root of <tt>${checkoutDirectory}</tt>.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.subDirectory</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CtryUpdate.3E"></a><b><a name="tryUpdate"><tryUpdate></a></b></h4> - -<div>If the checkout directory exists and this flag is activated, the -plugin will try an SCM-update instead of delete then checkout.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>scmpublish.tryUpdate</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Cusername.3E"></a><b><a name="username"><username></a></b></h4> - -<div>The SCM username to use.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>username</tt></li> - </ul> - </div></div> - </div> - - - </div> - </div> - </div> - <hr/> - <footer> - <div class="container-fluid"> - <div class="row-fluid"> - <p>Copyright ©2002–2020 -<a href="https://www.apache.org/";>The Apache Software Foundation</a>. -All rights reserved.</p> - </div> - </div> - </footer> - </body> +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/publish-scm-mojo.xml at 2023-03-26 + | Rendered using Apache Maven Fluido Skin 1.11.1 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Maven SCM Publish Plugin – scm-publish:publish-scm</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.1.min.js"></script> + + <!-- Matomo --> + <script> + var _paq = window._paq = window._paq || []; + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + + (function() { + var u="https://analytics.apache.org/";; + _paq.push(['setTrackerUrl', u+'/matomo.php']); + _paq.push(['setSiteId', '3']); + var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; + g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s); + })(); + </script> + <!-- End Matomo Code --> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <header> + <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" style="" /></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="clear"><hr/></div> + </div> + + <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 ">scm-publish:publish-scm</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-03-26</li> + <li id="projectVersion" class="pull-right">Version: 3.2.1</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav 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><a href="various-tips.html" title="Some Tips"><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="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</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://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</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> + </nav> + <div class="well sidebar-nav"> + <div id="poweredBy"> + <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> + </header> + <main id="bodyColumn" class="span10" > + + + <section> +<h2><a name="scm-publish:publish-scm"></a>scm-publish:publish-scm</h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.maven.plugins:maven-scm-publish-plugin:3.2.1:publish-scm</p> + +<p><b>Description</b>:</p> + +<div>Publish a content to scm. By default, content is taken from default site staging directory <code>${project.build.directory}/staging</code>. Can be used without project, so usable to update any SCM with any content.</div> + +<p><b>Attributes</b>:</p> + +<ul> + +<li>Executes as an aggregator plugin.</li> + +<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> + </ul> + <section> +<h3><a name="Required_Parameters"></a>Required Parameters</h3> + +<table class="table table-striped" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#pubScmUrl"><pubScmUrl></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>Location of the scm publication tree: <code>scm:<scm_provider><delimiter><provider_specific_part></code>. Example: <code>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</code><br /><b>Default value is</b>: <code>${project.distributionManagement.site.url}</code>.<br /><b>User property is</b>: <code>scmpublish.pubScmUrl</code>.<br /></td> + </tr> + </table> + </section> + <section> +<h3><a name="Optional_Parameters"></a>Optional Parameters</h3> + +<table class="table table-striped" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#addUniqueDirectory"><addUniqueDirectory></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Add each directory in a separated SCM command: this can be necessary if SCM does not support adding subdirectories in one command.<br /><b>Default value is</b>: <code>false</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#automaticRemotePathCreation"><automaticRemotePathCreation></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Configure svn automatic remote url creation.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>scmpublish.automaticRemotePathCreation</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#checkinComment"><checkinComment></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>SCM log/checkin comment for this publication.<br /><b>Default value is</b>: <code>Site checkin for project ${project.name}</code>.<br /><b>User property is</b>: <code>scmpublish.checkinComment</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#checkoutDirectory"><checkoutDirectory></a></code></td> + +<td><code>File</code></td> + +<td><code>-</code></td> + +<td>Location where the scm check-out is done. By default, scm checkout is done in build (target) directory, which is deleted on every <code>mvn clean</code>. To avoid this and get better performance, configure this location outside build structure and set <code>tryUpdate</code> to <code>true</code>. See <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html#Improving_SCM_Checkout_Performance";> Improving SCM Checkout Performance</a> for more information.<br /><b>Default value is</b>: <code>${project.build.directory}/scmpublish-checkout</code>.<br /><b>User property is</b>: <code>scmpublish.checkoutDirectory</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#content"><content></a></code></td> + +<td><code>File</code></td> + +<td><code>-</code></td> + +<td>The content to be published.<br /><b>Default value is</b>: <code>${project.build.directory}/staging</code>.<br /><b>User property is</b>: <code>scmpublish.content</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#dryRun"><dryRun></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Display list of added, deleted, and changed files, but do not do any actual SCM operations.<br /><b>User property is</b>: <code>scmpublish.dryRun</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#excludes"><excludes></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>Patterns to exclude from the scm tree.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#extraNormalizeExtensions"><extraNormalizeExtensions></a></code></td> + +<td><code>String[]</code></td> + +<td><code>-</code></td> + +<td>Extra file extensions to normalize line ending (will be added to default <code>html</code>,<code>css</code>,<code>js</code> list)<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#ignorePathsToDelete"><ignorePathsToDelete></a></code></td> + +<td><code>String[]</code></td> + +<td><code>-</code></td> + +<td>Collections of paths not to delete when checking content to delete. If your site has subdirectories published by an other mechanism/build<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#includes"><includes></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>Patterns to include in the scm tree.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#localCheckout"><localCheckout></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Use a local checkout instead of doing a checkout from the upstream repository. <b>WARNING</b>: This will only work with distributed SCMs which support the file:// protocol. TODO: we should think about having the defaults for the various SCM providers provided via Modello!<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>localCheckout</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#password"><password></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>The SCM password to use.<br /><b>User property is</b>: <code>password</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#providerImplementations"><providerImplementations></a></code></td> + +<td><code>Map<String,String></code></td> + +<td><code>-</code></td> + +<td>List of SCM provider implementations. Key is the provider type, eg. <code>cvs</code>. Value is the provider implementation (the role-hint of the provider), eg. <code>cvs</code> or <code>cvs_native</code>.<br /><b>See also:</b> ScmManager.setScmProviderImplementation<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#scmBranch"><scmBranch></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>SCM branch to use. For github, you must configure with <code>gh-pages</code>.<br /><b>User property is</b>: <code>scmpublish.scm.branch</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#serverId"><serverId></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>The serverId specified in the settings.xml, which should be used for the authentication.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#siteOutputEncoding"><siteOutputEncoding></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>The outputEncoding parameter of the site plugin. This plugin will corrupt your site if this does not match the value used by the site plugin.<br /><b>Default value is</b>: <code>${project.reporting.outputEncoding}</code>.<br /><b>User property is</b>: <code>outputEncoding</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#skipCheckin"><skipCheckin></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Run add and delete commands, but leave the actually checkin for the user to run manually.<br /><b>User property is</b>: <code>scmpublish.skipCheckin</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#skipDeletedFiles"><skipDeletedFiles></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Do not delete files to the scm<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>scmpublish.skipDeletedFiles</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#skipDeployement"><skipDeployement></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td><b>Deprecated.</b> Set this to 'true' to skip site deployment.<br /><b>Default value is</b>: <code>false</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#skipDeployment"><skipDeployment></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Set this to 'true' to skip site deployment.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>scmpublish.skipDeploy</code>.<br /><b>Alias is</b>: <code>maven.site.deploy.skip</code>.</td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#subDirectory"><subDirectory></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>Location where the content is published inside the <code>${checkoutDirectory}</code>. By default, content is copyed at the root of <code>${checkoutDirectory}</code>.<br /><b>User property is</b>: <code>scmpublish.subDirectory</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#tryUpdate"><tryUpdate></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>If the checkout directory exists and this flag is activated, the plugin will try an SCM-update instead of delete then checkout.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>scmpublish.tryUpdate</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#username"><username></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>The SCM username to use.<br /><b>User property is</b>: <code>username</code>.<br /></td> + </tr> + </table> + </section> + <section> +<h3><a name="Parameter_Details"></a>Parameter Details</h3> + <section> +<h4><a name="a.3CaddUniqueDirectory.3E"></a><b><a name="addUniqueDirectory"><addUniqueDirectory></a></b></h4> + +<div>Add each directory in a separated SCM command: this can be necessary if SCM does not support adding subdirectories in one command.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CautomaticRemotePathCreation.3E"></a><b><a name="automaticRemotePathCreation"><automaticRemotePathCreation></a></b></h4> + +<div>Configure svn automatic remote url creation.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.automaticRemotePathCreation</code></li> + +<li><b>Default</b>: <code>true</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CcheckinComment.3E"></a><b><a name="checkinComment"><checkinComment></a></b></h4> + +<div>SCM log/checkin comment for this publication.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.checkinComment</code></li> + +<li><b>Default</b>: <code>Site checkin for project ${project.name}</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CcheckoutDirectory.3E"></a><b><a name="checkoutDirectory"><checkoutDirectory></a></b></h4> + +<div>Location where the scm check-out is done. By default, scm checkout is done in build (target) directory, which is deleted on every <code>mvn clean</code>. To avoid this and get better performance, configure this location outside build structure and set <code>tryUpdate</code> to <code>true</code>. See <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html#Improving_SCM_Checkout_Performance";> Improving SCM Checkout Performance</a> for more information.</div> + +<ul> + +<li><b>Type</b>: <code>java.io.File</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.checkoutDirectory</code></li> + +<li><b>Default</b>: <code>${project.build.directory}/scmpublish-checkout</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Ccontent.3E"></a><b><a name="content"><content></a></b></h4> + +<div>The content to be published.</div> + +<ul> + +<li><b>Type</b>: <code>java.io.File</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.content</code></li> + +<li><b>Default</b>: <code>${project.build.directory}/staging</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CdryRun.3E"></a><b><a name="dryRun"><dryRun></a></b></h4> + +<div>Display list of added, deleted, and changed files, but do not do any actual SCM operations.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.dryRun</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> + +<div>Patterns to exclude from the scm tree.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CextraNormalizeExtensions.3E"></a><b><a name="extraNormalizeExtensions"><extraNormalizeExtensions></a></b></h4> + +<div>Extra file extensions to normalize line ending (will be added to default <code>html</code>,<code>css</code>,<code>js</code> list)</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String[]</code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CignorePathsToDelete.3E"></a><b><a name="ignorePathsToDelete"><ignorePathsToDelete></a></b></h4> + +<div>Collections of paths not to delete when checking content to delete. If your site has subdirectories published by an other mechanism/build</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String[]</code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> + +<div>Patterns to include in the scm tree.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3ClocalCheckout.3E"></a><b><a name="localCheckout"><localCheckout></a></b></h4> + +<div>Use a local checkout instead of doing a checkout from the upstream repository. <b>WARNING</b>: This will only work with distributed SCMs which support the file:// protocol. TODO: we should think about having the defaults for the various SCM providers provided via Modello!</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>localCheckout</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Cpassword.3E"></a><b><a name="password"><password></a></b></h4> + +<div>The SCM password to use.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>password</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CproviderImplementations.3E"></a><b><a name="providerImplementations"><providerImplementations></a></b></h4> + +<div>List of SCM provider implementations. Key is the provider type, eg. <code>cvs</code>. Value is the provider implementation (the role-hint of the provider), eg. <code>cvs</code> or <code>cvs_native</code>.<br /><b>See also:</b> ScmManager.setScmProviderImplementation</div> + +<ul> + +<li><b>Type</b>: <code>java.util.Map<java.lang.String, java.lang.String></code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CpubScmUrl.3E"></a><b><a name="pubScmUrl"><pubScmUrl></a></b></h4> + +<div>Location of the scm publication tree: <code>scm:<scm_provider><delimiter><provider_specific_part></code>. Example: <code>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</code></div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>Yes</code></li> + +<li><b>User Property</b>: <code>scmpublish.pubScmUrl</code></li> + +<li><b>Default</b>: <code>${project.distributionManagement.site.url}</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CscmBranch.3E"></a><b><a name="scmBranch"><scmBranch></a></b></h4> + +<div>SCM branch to use. For github, you must configure with <code>gh-pages</code>.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.scm.branch</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CserverId.3E"></a><b><a name="serverId"><serverId></a></b></h4> + +<div>The serverId specified in the settings.xml, which should be used for the authentication.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CsiteOutputEncoding.3E"></a><b><a name="siteOutputEncoding"><siteOutputEncoding></a></b></h4> + +<div>The outputEncoding parameter of the site plugin. This plugin will corrupt your site if this does not match the value used by the site plugin.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>outputEncoding</code></li> + +<li><b>Default</b>: <code>${project.reporting.outputEncoding}</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CskipCheckin.3E"></a><b><a name="skipCheckin"><skipCheckin></a></b></h4> + +<div>Run add and delete commands, but leave the actually checkin for the user to run manually.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.skipCheckin</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CskipDeletedFiles.3E"></a><b><a name="skipDeletedFiles"><skipDeletedFiles></a></b></h4> + +<div>Do not delete files to the scm</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.skipDeletedFiles</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CskipDeployement.3E"></a><b><a name="skipDeployement"><skipDeployement></a></b></h4> + +<div><b>Deprecated.</b> Please use <a href="#skipDeployment"><code>skipDeployment</code></a>.</div> + +<div>Set this to 'true' to skip site deployment.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CskipDeployment.3E"></a><b><a name="skipDeployment"><skipDeployment></a></b></h4> + +<div>Set this to 'true' to skip site deployment.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.skipDeploy</code></li> + +<li><b>Default</b>: <code>false</code></li> + +<li><b>Alias</b>: <code>maven.site.deploy.skip</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CsubDirectory.3E"></a><b><a name="subDirectory"><subDirectory></a></b></h4> + +<div>Location where the content is published inside the <code>${checkoutDirectory}</code>. By default, content is copyed at the root of <code>${checkoutDirectory}</code>.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.subDirectory</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CtryUpdate.3E"></a><b><a name="tryUpdate"><tryUpdate></a></b></h4> + +<div>If the checkout directory exists and this flag is activated, the plugin will try an SCM-update instead of delete then checkout.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>scmpublish.tryUpdate</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Cusername.3E"></a><b><a name="username"><username></a></b></h4> + +<div>The SCM username to use.</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>username</code></li> + </ul> + </section></section> + </section> + + + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>© 2002–2023 +<a href="https://www.apache.org/";>The Apache Software Foundation</a> +</p> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> </html> \ No newline at end of file
Modified: maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/scm.html ============================================================================== --- maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/scm.html (original) +++ maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/scm.html Sun Mar 26 17:47:20 2023 @@ -1,157 +1,159 @@ -<!DOCTYPE html> -<!-- - | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:scm at 2020-12-23 - | Rendered using Apache Maven Fluido Skin 1.7 ---> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> - <head> - <meta charset="UTF-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20201223" /> - <meta http-equiv="Content-Language" content="en" /> - <title>Apache Maven SCM Publish Plugin – Source Code Management</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 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 ">Source Code Management</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2020-12-23</li> - <li id="projectVersion" class="pull-right">Version: 3.1.0</li> - </ul> - </div> - <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><a href="various-tips.html" title="Some Tips"><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-down"></span>Project Information</a> - <ul class="nav nav-list"> - <li><a href="index.html" title="About"><span class="none"></span>About</a></li> - <li><a href="summary.html" title="Summary"><span class="none"></span>Summary</a></li> - <li><a href="dependency-info.html" title="Dependency Information"><span class="none"></span>Dependency Information</a></li> - <li><a href="team.html" title="Team"><span class="none"></span>Team</a></li> - <li class="active"><a href="#"><span class="none"></span>Source Code Management</a></li> - <li><a href="issue-management.html" title="Issue Management"><span class="none"></span>Issue Management</a></li> - <li><a href="mailing-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li> - <li><a href="dependency-management.html" title="Dependency Management"><span class="none"></span>Dependency Management</a></li> - <li><a href="dependencies.html" title="Dependencies"><span class="none"></span>Dependencies</a></li> - <li><a href="dependency-convergence.html" title="Dependency Convergence"><span class="none"></span>Dependency Convergence</a></li> - <li><a href="ci-management.html" title="CI Management"><span class="none"></span>CI Management</a></li> - <li><a href="plugin-management.html" title="Plugin Management"><span class="none"></span>Plugin Management</a></li> - <li><a href="plugins.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="distribution-management.html" title="Distribution Management"><span class="none"></span>Distribution Management</a></li> - </ul> -</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="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</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="maven.apache.org/plugins/maven-scm-publish-plugin/" 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"> - <div class="clear"></div> - <div class="clear"></div> - <div id="twitter"> - <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> - <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </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"> -<h2><a name="Overview"></a>Overview</h2><a name="Overview"></a> -<p>This project uses <a class="externalLink" href="https://git-scm.com/";>Git</a> to manage its source code. Instructions on Git use can be found at <a class="externalLink" href="https://git-scm.com/documentation";>https://git-scm.com/documentation</a>.</p></div> -<div class="section"> -<h2><a name="Web_Browser_Access"></a>Web Browser Access</h2><a name="Web_Browser_Access"></a> -<p>The following is a link to a browsable version of the source repository:</p> -<div class="source"><pre class="prettyprint linenums"><a class="externalLink" href="https://github.com/apache/maven-scm-publish-plugin/tree/maven-scm-publish-plugin-3.1.0";>https://github.com/apache/maven-scm-publish-plugin/tree/maven-scm-publish-plugin-3.1.0</a></pre></div></div> -<div class="section"> -<h2><a name="Anonymous_Access"></a>Anonymous Access</h2><a name="Anonymous_Access"></a> -<p>The source can be checked out anonymously from Git with this command (See <a class="externalLink" href="https://git-scm.com/docs/git-clone";>https://git-scm.com/docs/git-clone</a>):</p> -<div class="source"><pre class="prettyprint linenums">$ git clone --branch maven-scm-publish-plugin-3.1.0 https://gitbox.apache.org/repos/asf/maven-scm-publish-plugin.git</pre></div></div> -<div class="section"> -<h2><a name="Developer_Access"></a>Developer Access</h2><a name="Developer_Access"></a> -<p>Only project developers can access the Git tree via this method (See <a class="externalLink" href="https://git-scm.com/docs/git-clone";>https://git-scm.com/docs/git-clone</a>).</p> -<div class="source"><pre class="prettyprint linenums">$ git clone --branch maven-scm-publish-plugin-3.1.0 https://gitbox.apache.org/repos/asf/maven-scm-publish-plugin.git</pre></div></div> -<div class="section"> -<h2><a name="Access_from_Behind_a_Firewall"></a>Access from Behind a Firewall</h2><a name="Access_from_Behind_a_Firewall"></a> -<p>Refer to the documentation of the SCM used for more information about access behind a firewall.</p></div> - </div> - </div> - </div> - <hr/> - <footer> - <div class="container-fluid"> - <div class="row-fluid"> - <p>Copyright ©2002–2020 -<a href="https://www.apache.org/";>The Apache Software Foundation</a>. -All rights reserved.</p> - </div> - </div> - </footer> - </body> +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.1:scm at 2023-03-26 + | Rendered using Apache Maven Fluido Skin 1.11.1 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Maven SCM Publish Plugin – Source Code Management</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.1.min.js"></script> + + <!-- Matomo --> + <script> + var _paq = window._paq = window._paq || []; + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + + (function() { + var u="https://analytics.apache.org/";; + _paq.push(['setTrackerUrl', u+'/matomo.php']); + _paq.push(['setSiteId', '3']); + var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; + g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s); + })(); + </script> + <!-- End Matomo Code --> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <header> + <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" style="" /></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="clear"><hr/></div> + </div> + + <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 ">Source Code Management</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-03-26</li> + <li id="projectVersion" class="pull-right">Version: 3.2.1</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav 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><a href="various-tips.html" title="Some Tips"><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-down"></span>Project Information</a> + <ul class="nav nav-list"> + <li><a href="index.html" title="About"><span class="none"></span>About</a></li> + <li><a href="summary.html" title="Summary"><span class="none"></span>Summary</a></li> + <li><a href="dependency-info.html" title="Dependency Information"><span class="none"></span>Dependency Information</a></li> + <li><a href="team.html" title="Team"><span class="none"></span>Team</a></li> + <li class="active"><a><span class="none"></span>Source Code Management</a></li> + <li><a href="issue-management.html" title="Issue Management"><span class="none"></span>Issue Management</a></li> + <li><a href="mailing-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li> + <li><a href="dependency-management.html" title="Dependency Management"><span class="none"></span>Dependency Management</a></li> + <li><a href="dependencies.html" title="Dependencies"><span class="none"></span>Dependencies</a></li> + <li><a href="dependency-convergence.html" title="Dependency Convergence"><span class="none"></span>Dependency Convergence</a></li> + <li><a href="ci-management.html" title="CI Management"><span class="none"></span>CI Management</a></li> + <li><a href="plugin-management.html" title="Plugin Management"><span class="none"></span>Plugin Management</a></li> + <li><a href="plugins.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="distribution-management.html" title="Distribution Management"><span class="none"></span>Distribution Management</a></li> + </ul></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="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</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://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</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> + </nav> + <div class="well sidebar-nav"> + <div id="poweredBy"> + <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> + </header> + <main id="bodyColumn" class="span10" > +<section> +<h2><a name="Overview"></a>Overview</h2><a name="Overview"></a> +<p>This project uses <a class="externalLink" href="https://git-scm.com/";>Git</a> to manage its source code. Instructions on Git use can be found at <a class="externalLink" href="https://git-scm.com/documentation";>https://git-scm.com/documentation</a>.</p></section><section> +<h2><a name="Web_Browser_Access"></a>Web Browser Access</h2><a name="Web_Browser_Access"></a> +<p>The following is a link to a browsable version of the source repository:</p> +<div class="source"><pre class="prettyprint linenums"><a class="externalLink" href="https://github.com/apache/maven-scm-publish-plugin/tree/maven-scm-publish-plugin-3.2.1";>https://github.com/apache/maven-scm-publish-plugin/tree/maven-scm-publish-plugin-3.2.1</a></pre></div></section><section> +<h2><a name="Anonymous_Access"></a>Anonymous Access</h2><a name="Anonymous_Access"></a> +<p>The source can be checked out anonymously from Git with this command (See <a class="externalLink" href="https://git-scm.com/docs/git-clone";>https://git-scm.com/docs/git-clone</a>):</p> +<div class="source"><pre class="prettyprint linenums">$ git clone --branch maven-scm-publish-plugin-3.2.1 https://gitbox.apache.org/repos/asf/maven-scm-publish-plugin.git</pre></div></section><section> +<h2><a name="Developer_Access"></a>Developer Access</h2><a name="Developer_Access"></a> +<p>Only project developers can access the Git tree via this method (See <a class="externalLink" href="https://git-scm.com/docs/git-clone";>https://git-scm.com/docs/git-clone</a>).</p> +<div class="source"><pre class="prettyprint linenums">$ git clone --branch maven-scm-publish-plugin-3.2.1 https://gitbox.apache.org/repos/asf/maven-scm-publish-plugin.git</pre></div></section><section> +<h2><a name="Access_from_Behind_a_Firewall"></a>Access from Behind a Firewall</h2><a name="Access_from_Behind_a_Firewall"></a> +<p>Refer to the documentation of the SCM used for more information about access behind a firewall.</p></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>© 2002–2023 +<a href="https://www.apache.org/";>The Apache Software Foundation</a> +</p> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> </html> \ No newline at end of file
