Google Git
Sign in
eclipse / gerrit / www.eclipse.org / tycho / 621728a1b0e298d41cf46e95183ab65ab5fd841a / . / sitedocs / tycho-packaging-plugin / build-qualifier-mojo.html
blob: c2baeb87ef772b2452edba85a95d559f703dfcc6 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Oct 15, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
tycho-packaging:build-qualifier</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20121015" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<div id="bannerLeft">
Tycho OSGi Packaging Plugin (Incubation)
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2012-10-15</span>
&nbsp;| <span id="projectVersion">Version: 0.16.0</span>
</div>
<div class="xright"> <a href="http://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase#.281.29_What_Is_Incubation.3F" class="externalLink" title="This content is PRELIMINARY API and still subject to change">This content is PRELIMINARY API and still subject to change</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Tycho</h5>
<ul>
<li class="none">
<a href="../index.html" title="Introduction">Introduction</a>
</li>
<li class="none">
<a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin">Compiler Plugin</a>
</li>
<li class="none">
<a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin">Packaging Plugin</a>
</li>
<li class="none">
<a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin">Source Plugin</a>
</li>
<li class="none">
<a href="../tycho-surefire/tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin">Surefire Plugin</a>
</li>
<li class="none">
<a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin">Versions Plugin</a>
</li>
<li class="none">
<a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="P2 Director Plugin">P2 Director Plugin</a>
</li>
<li class="none">
<a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="P2 Repository Plugin">P2 Repository Plugin</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>tycho-packaging:build-qualifier<a name="tycho-packaging:build-qualifier"></a></h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho:tycho-packaging-plugin:0.16.0:build-qualifier</p>
<p><b>Description</b>:</p>
<div>This mojo generates build qualifier according to the rules outlined
in
http://help.eclipse.org/ganymede/topic/org.eclipse.pde.doc.user/tasks/pde_version_qualifiers.htm
<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 (ie 200605121600)</li>
</ol>
<p>The generated qualifier is assigned to
<tt>buildQualifier</tt> project property. Unqualified project
version is assigned to <tt>unqualifiedVersion</tt> project
property. Unqualified version is calculated based on
<tt>${project.version}</tt> and can be used for any Tycho
project (eclipse-update-site, eclipse-application, etc) and regular
maven project. Different projects can use different formats to
expand the timestamp, however (highly not recommended but
possible).</p>
<p>Starting with version 0.16, it is now possible to use custom
build timestamp generation logic. The primary usecase 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 lifecycle phase: <tt>validate</tt>.</li>
</ul>
<div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
<table class="bodyTable" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#baseDir">baseDir</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#execution">execution</a></b></td>
<td><tt>MojoExecution</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /></td>
</tr>
<tr class="b">
<td><b><a href="#forceContextQualifier">forceContextQualifier</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /></td>
</tr>
<tr class="a">
<td><b><a href="#format">format</a></b></td>
<td><tt>SimpleDateFormat</tt></td>
<td><tt>-</tt></td>
<td>Specify a date format as specified by java.text.SimpleDateFormat.
Timezone used is UTC.<br /><b>Default value is</b>: <tt>yyyyMMddHHmm</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#timestampProvider">timestampProvider</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Role hint of a custom build timestamp provider.<br /></td>
</tr>
</table>
</div>
<div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
<p><b><a name="baseDir">baseDir</a>:</b></p>
<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>Default</b>: <tt>${project.basedir}</tt></li>
</ul><hr /><p><b><a name="execution">execution</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>org.apache.maven.plugin.MojoExecution</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${mojoExecution}</tt></li>
</ul><hr /><p><b><a name="forceContextQualifier">forceContextQualifier</a>:</b></p>
<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>Expression</b>: <tt>${forceContextQualifier}</tt></li>
</ul><hr /><p><b><a name="format">format</a>:</b></p>
<div>Specify a date format as specified by java.text.SimpleDateFormat.
Timezone used is UTC.</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 /><p><b><a name="timestampProvider">timestampProvider</a>:</b></p>
<div>Role hint of a custom build timestamp provider.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul>
</div>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright &#169; 2008-2012
<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>