blob: 94686b337373c5e42b4482333287ad34923e4b07 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2018-12-17
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<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="20181217" />
<meta http-equiv="Content-Language" content="en" />
<title>p2 Extras Plugin &#x2013; tycho-p2-extras:publish-features-and-bundles</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.3.0.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>p2 Extras Plugin</h2>
</div>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2018-12-17</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.3.0</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Tycho Extras</li>
<li>
<a href="../index.html" title="Introduction">
<i class="none"></i>
Introduction</a>
</li>
<li>
<a href="../tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin">
<i class="none"></i>
P2 Extras Plugin</a>
</li>
<li>
<a href="../target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin">
<i class="none"></i>
Target Platform Validation Plugin</a>
</li>
<li>
<a href="../tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin">
<i class="none"></i>
Eclipserun Plugin</a>
</li>
<li>
<a href="../tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin">
<i class="none"></i>
Document Bundle Plugin</a>
</li>
<li>
<a href="../tycho-source-feature-plugin/plugin-info.html" title="Source Feature Generation Plugin">
<i class="none"></i>
Source Feature Generation Plugin</a>
</li>
<li>
<a href="../tycho-pack200/index.html" title="Pack200 Plugins">
<i class="icon-chevron-down"></i>
Pack200 Plugins</a>
<ul class="nav nav-list">
<li>
<a href="../tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin">
<i class="none"></i>
Normalization Plugin</a>
</li>
<li>
<a href="../tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin">
<i class="none"></i>
Pack Plugin</a>
</li>
</ul>
</li>
</ul>
<hr class="divider" />
<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>
</div>
<div id="bodyColumn" class="span9" >
<div class="section">
<h2><a name="tycho-p2-extras:publish-features-and-bundles"></a>tycho-p2-extras:publish-features-and-bundles</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho.extras:tycho-p2-extras-plugin:1.3.0:publish-features-and-bundles</p>
<p><b>Description</b>:</p>
<div>This goal invokes the feature and bundle publisher on a folder.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
</ul>
<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="#additionalArgs">&lt;additionalArgs&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Optional line of additional arguments passed to the p2 application
launcher.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#append">&lt;append&gt;</a></tt></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Optional flag to append artifacts to an existing repository<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#artifactRepositoryLocation">&lt;artifactRepositoryLocation&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Location of the artifact repository to write. Note: The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.<br /><b>Default value is</b>: <tt>${project.build.directory}/repository</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#compress">&lt;compress&gt;</a></tt></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Create compressed jars rather than plain xml<br /><b>Default value is</b>: <tt>true</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#forkedProcessTimeoutInSeconds">&lt;forkedProcessTimeoutInSeconds&gt;</a></tt></td>
<td><tt>int</tt></td>
<td><tt>-</tt></td>
<td>Kill the forked process after a certain number of seconds. If set
to 0, wait forever for the process, never timing out.<br /><b>Default value is</b>: <tt>0</tt>.<br /><b>User property is</b>: <tt>p2.timeout</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#metadataRepositoryLocation">&lt;metadataRepositoryLocation&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Location of the metadata repository to write. The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.<br /><b>Default value is</b>: <tt>${project.build.directory}/repository</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#project">&lt;project&gt;</a></tt></td>
<td><tt>MavenProject</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>User property is</b>: <tt>project</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#publishArtifacts">&lt;publishArtifacts&gt;</a></tt></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Publish artifacts to repository<br /><b>Default value is</b>: <tt>true</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#reusePack200Files">&lt;reusePack200Files&gt;</a></tt></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Optional flag to include .pack.gz files<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#sourceLocation">&lt;sourceLocation&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Location with features and/or plugins directories on which the
features and bundles publisher shall be called.<br /><b>Default value is</b>: <tt>${project.build.directory}/source</tt>.<br /></td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<div class="section">
<h4><a name="aadditionalArgs"></a><b><a name="additionalArgs">&lt;additionalArgs&gt;</a></b></h4>
<div>Optional line of additional arguments passed to the p2 application
launcher.</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="aappend"></a><b><a name="append">&lt;append&gt;</a></b></h4>
<div>Optional flag to append artifacts to an existing repository</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="aartifactRepositoryLocation"></a><b><a name="artifactRepositoryLocation">&lt;artifactRepositoryLocation&gt;</a></b></h4>
<div>Location of the artifact repository to write. Note: The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/repository</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="acompress"></a><b><a name="compress">&lt;compress&gt;</a></b></h4>
<div>Create compressed jars rather than plain xml</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aforkedProcessTimeoutInSeconds"></a><b><a name="forkedProcessTimeoutInSeconds">&lt;forkedProcessTimeoutInSeconds&gt;</a></b></h4>
<div>Kill the forked process after a certain number of seconds. If set
to 0, wait forever for the process, never timing out.</div>
<ul>
<li><b>Type</b>: <tt>int</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>p2.timeout</tt></li>
<li><b>Default</b>: <tt>0</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="ametadataRepositoryLocation"></a><b><a name="metadataRepositoryLocation">&lt;metadataRepositoryLocation&gt;</a></b></h4>
<div>Location of the metadata repository to write. The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/repository</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="aproject"></a><b><a name="project">&lt;project&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>org.apache.maven.project.MavenProject</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>project</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="apublishArtifacts"></a><b><a name="publishArtifacts">&lt;publishArtifacts&gt;</a></b></h4>
<div>Publish artifacts to repository</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="areusePack200Files"></a><b><a name="reusePack200Files">&lt;reusePack200Files&gt;</a></b></h4>
<div>Optional flag to include .pack.gz files</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="asourceLocation"></a><b><a name="sourceLocation">&lt;sourceLocation&gt;</a></b></h4>
<div>Location with features and/or plugins directories on which the
features and bundles publisher shall be called.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/source</tt></li>
</ul>
</div></div>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row span12">Copyright &copy; 2010-2018
<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>