blob: b6fdff8a99650285f55c80bde237d9a205b99047 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.8.1 from target/generated-site/xdoc/build-qualifier-mojo.xml at 2019-04-05
| 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="20190405" />
<meta http-equiv="Content-Language" content="en" />
<title>Tycho OSGi Packaging Plugin &#x2013; tycho-packaging:build-qualifier</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>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Tycho OSGi Packaging 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: 2019-04-05<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.4.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">Tycho</li>
<li><a href="../index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
<li><a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"><span class="none"></span>Compiler Plugin</a></li>
<li><a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin"><span class="none"></span>Packaging Plugin</a></li>
<li><a href="../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li>
<li><a href="../tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin"><span class="none"></span>Surefire Plugin</a></li>
<li><a href="../tycho-p2/tycho-p2-publisher-plugin/plugin-info.html" title="p2 Publisher Plugin"><span class="none"></span>p2 Publisher Plugin</a></li>
<li><a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="p2 Repository Plugin"><span class="none"></span>p2 Repository Plugin</a></li>
<li><a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="p2 Director Plugin"><span class="none"></span>p2 Director Plugin</a></li>
<li><a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin"><span class="none"></span>Source Plugin</a></li>
<li><a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin"><span class="none"></span>Versions Plugin</a></li>
<li><a href="../tycho-pomgenerator-plugin/plugin-info.html" title="POM Generator Plugin"><span class="none"></span>POM Generator Plugin</a></li>
<li><a href="../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li>
</ul>
<hr />
<div id="poweredBy">
<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">
<h2><a name="tycho-packaging:build-qualifier"></a>tycho-packaging:build-qualifier</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho:tycho-packaging-plugin:1.4.0:build-qualifier</p>
<p><b>Description</b>:</p>
<div>
<p>This mojo generates the build qualifier according to the <a class="externalLink" href="http://help.eclipse.org/kepler/topic/org.eclipse.pde.doc.user/tasks/pde_version_qualifiers.htm">rules
described in the PDE documentation</a>:</p>
<ol style="list-style-type: decimal">
<li>Explicit -DforceContextQualifier command line parameter</li>
<li>forceContextQualifier from
${project.baseDir}/build.properties</li>
<li>A time stamp in the form YYYYMMDDHHMM (e.g. 200605121600)</li>
</ol>
<br />
<br />
<p>The generated qualifier is assigned to
<tt>buildQualifier</tt> project property. The unqualified
project version is assigned to <tt>unqualifiedVersion</tt>
project property. The unqualified version is calculated based on
<tt>${project.version}</tt> and can be used for any Tycho
project and regular Maven project. Different projects can use
different formats to expand the timestamp (not recommended). The
concatenation of <tt>${unqualifiedVersion}</tt> and
<tt>${buildQualifier}</tt>, if not empty, is assigned to the
project property <tt>qualifiedVersion</tt>.</p>
<p>The timestamp generation logic is extensible. The primary use
case is to generate build version qualifier based on the timestamp
of the last project commit. Here is example pom.xml snippet that
enables custom timestamp generation logic</p>
<div>
<pre>
...
&lt;plugin&gt;
&lt;groupId&gt;org.eclipse.tycho&lt;/groupId&gt;
&lt;artifactId&gt;tycho-packaging-plugin&lt;/artifactId&gt;
&lt;version&gt;${tycho-version}&lt;/version&gt;
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;timestamp-provider-groupid&lt;/groupId&gt;
&lt;artifactId&gt;timestamp-provider-artifactid&lt;/artifactId&gt;
&lt;version&gt;timestamp-provider-version&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
&lt;configuration&gt;
&lt;timestampProvider&gt;custom&lt;/timestampProvider&gt;
&lt;/configuration&gt;
&lt;/plugin&gt;
...
</pre></div></div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>validate</tt>.</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="#baseDir">&lt;baseDir&gt;</a></tt></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td><b>Deprecated.</b> This parameter is deprecated and may be removed in future versions
of Tycho.<br /><b>User property is</b>: <tt>project.basedir</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#forceContextQualifier">&lt;forceContextQualifier&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>User property is</b>: <tt>forceContextQualifier</tt>.<br /></td>
</tr>
<tr class="b">
<td><tt><a href="#format">&lt;format&gt;</a></tt></td>
<td><tt>SimpleDateFormat</tt></td>
<td><tt>-</tt></td>
<td>
<p>Specify a date format as specified by
java.text.SimpleDateFormat. Timezone used is UTC.</p><br /><b>Default value is</b>: <tt>yyyyMMddHHmm</tt>.<br /></td>
</tr>
<tr class="a">
<td><tt><a href="#timestampProvider">&lt;timestampProvider&gt;</a></tt></td>
<td><tt>String</tt></td>
<td><tt>0.16.0</tt></td>
<td>
<p>Role hint of a custom build timestamp provider.</p><br /></td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<div class="section">
<h4><a name="a.3CbaseDir.3E"></a><b><a name="baseDir">&lt;baseDir&gt;</a></b></h4>
<div><b>Deprecated.</b> This parameter is deprecated and may be removed in future versions
of Tycho.</div>
<div>(no description)</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>project.basedir</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="a.3CforceContextQualifier.3E"></a><b><a name="forceContextQualifier">&lt;forceContextQualifier&gt;</a></b></h4>
<div>(no description)</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>forceContextQualifier</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="a.3Cformat.3E"></a><b><a name="format">&lt;format&gt;</a></b></h4>
<div>
<p>Specify a date format as specified by
java.text.SimpleDateFormat. Timezone used is UTC.</p></div>
<ul>
<li><b>Type</b>: <tt>java.text.SimpleDateFormat</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>yyyyMMddHHmm</tt></li>
</ul><hr /></div>
<div class="section">
<h4><a name="a.3CtimestampProvider.3E"></a><b><a name="timestampProvider">&lt;timestampProvider&gt;</a></b></h4>
<div>
<p>Role hint of a custom build timestamp provider.</p></div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>0.16.0</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul>
</div></div>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &copy;2008&#x2013;2019
<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
All rights reserved.</p>
</div>
</div>
</footer>
</body>
</html>