| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at Oct 28, 2013 |
| | 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="20131028" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title> |
| tycho-packaging:build-qualifier</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>Tycho OSGi Packaging Plugin (Incubation)</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: 2013-10-28</li> |
| <li class="divider">|</li> <li id="projectVersion">Version: 0.19.0</li> |
| |
| |
| |
| |
| |
| <li class="pull-right"> <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> |
| </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</li> |
| |
| <li> |
| |
| <a href="../index.html" title="Introduction"> |
| <i class="none"></i> |
| Introduction</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"> |
| <i class="none"></i> |
| Compiler Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin"> |
| <i class="none"></i> |
| Packaging Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-surefire/tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin"> |
| <i class="none"></i> |
| Surefire Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-p2/tycho-p2-publisher-plugin/plugin-info.html" title="p2 Publisher Plugin"> |
| <i class="none"></i> |
| p2 Publisher Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="p2 Repository Plugin"> |
| <i class="none"></i> |
| p2 Repository Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="p2 Director Plugin"> |
| <i class="none"></i> |
| p2 Director Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin"> |
| <i class="none"></i> |
| Source Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin"> |
| <i class="none"></i> |
| Versions Plugin</a> |
| </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>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.19.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>
|
| ...
|
| <plugin>
|
| <groupId>org.eclipse.tycho</groupId>
|
| <artifactId>tycho-packaging-plugin</artifactId>
|
| <version>${tycho-version}</version>
|
| <dependencies>
|
| <dependency>
|
| <groupId>timestamp-provider-groupid</groupId>
|
| <artifactId>timestamp-provider-artifactid</artifactId>
|
| <version>timestamp-provider-version</version>
|
| </dependency>
|
| </dependencies>
|
| <configuration>
|
| <timestampProvider>custom</timestampProvider>
|
| </configuration>
|
| </plugin>
|
| ...
|
|
|
| </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="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><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> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row span12">Copyright © 2008-2013 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
