| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2018-06-05 |
| | 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="20180605" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Tycho OSGi Packaging Plugin – 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</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-06-05</li> |
| <li class="divider">|</li> <li id="projectVersion">Version: 1.2.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</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="../BuildProperties.html" title="Build Properties"> |
| <i class="none"></i> |
| Build Properties</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> |
| |
| <li> |
| |
| <a href="../tycho-pomgenerator-plugin/plugin-info.html" title="POM Generator Plugin"> |
| <i class="none"></i> |
| POM Generator Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../TychoProperties.html" title="Tycho Properties"> |
| <i class="none"></i> |
| Tycho Properties</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><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.2.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> |
| ... |
| <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 <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><b><a href="#baseDir">baseDir</a></b></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>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#forceContextQualifier">forceContextQualifier</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>(no description)<br /><b>User property is</b>: <tt>forceContextQualifier</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#format">format</a></b></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><b><a href="#timestampProvider">timestampProvider</a></b></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> |
| |
| <p><b><a name="baseDir">baseDir</a>:</b></p> |
| |
| <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 /> |
| <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>User Property</b>: <tt>forceContextQualifier</tt></li> |
| </ul><hr /> |
| <p><b><a name="format">format</a>:</b></p> |
| |
| <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 /> |
| <p><b><a name="timestampProvider">timestampProvider</a>:</b></p> |
| |
| <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> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row span12">Copyright © 2008-2018 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
