| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.1 from target/generated-site/xdoc/build-qualifier-mojo.xml at 2020-04-06 |
| | Rendered using Apache Maven Fluido Skin 1.8 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.1" /> |
| <title>Tycho OSGi Packaging Plugin – tycho-packaging:build-qualifier</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.8.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-1.8.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <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: 2020-04-06<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.7.0</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav 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="../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="" title="Properties"><span class="icon-chevron-down"></span>Properties</a> |
| <ul class="nav nav-list"> |
| <li><a href="../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li> |
| <li><a href="../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li> |
| </ul></li> |
| <li class="nav-header">Tycho Extras</li> |
| <li><a href="../tycho-extras/index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../tycho-extras/tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin"><span class="none"></span>P2 Extras Plugin</a></li> |
| <li><a href="../tycho-extras/target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin"><span class="none"></span>Target Platform Validation Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin"><span class="none"></span>Eclipserun Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin"><span class="none"></span>Document Bundle Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-source-feature-plugin/plugin-info.html" title="Source Feature Generation Plugin"><span class="none"></span>Source Feature Generation Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-pack200/index.html" title="Pack200 Plugins"><span class="icon-chevron-down"></span>Pack200 Plugins</a> |
| <ul class="nav nav-list"> |
| <li><a href="../tycho-extras/tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin"><span class="none"></span>Normalization Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin"><span class="none"></span>Pack Plugin</a></li> |
| </ul></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <hr /> |
| <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> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| |
| |
| <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.7.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 |
| buildQualifier project property. The unqualified |
| project version is assigned to unqualifiedVersion |
| project property. The unqualified version is calculated based on |
| ${project.version} 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 ${unqualifiedVersion} and |
| ${buildQualifier}, if not empty, is assigned to the |
| project property qualifiedVersion.</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>: validate.</li> |
| </ul> |
| <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><a href="#baseDir"><baseDir></a></td> |
| |
| <td>File</td> |
| |
| <td>-</td> |
| |
| <td><b>Deprecated.</b> This parameter is deprecated and may be removed in future versions |
| of Tycho.<br /><b>User property is</b>: project.basedir.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#forceContextQualifier"><forceContextQualifier></a></td> |
| |
| <td>String</td> |
| |
| <td>-</td> |
| |
| <td>(no description)<br /><b>User property is</b>: forceContextQualifier.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#format"><format></a></td> |
| |
| <td>SimpleDateFormat</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>Specify a date format as specified by |
| java.text.SimpleDateFormat. Timezone used is UTC.</p><br /><b>Default value is</b>: yyyyMMddHHmm.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#timestampProvider"><timestampProvider></a></td> |
| |
| <td>String</td> |
| |
| <td>0.16.0</td> |
| |
| <td> |
| <p>Role hint of a custom build timestamp provider.</p><br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CbaseDir.3E"></a><b><a name="baseDir"><baseDir></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>: java.io.File</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: project.basedir</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CforceContextQualifier.3E"></a><b><a name="forceContextQualifier"><forceContextQualifier></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.lang.String</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: forceContextQualifier</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cformat.3E"></a><b><a name="format"><format></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>: java.text.SimpleDateFormat</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: yyyyMMddHHmm</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtimestampProvider.3E"></a><b><a name="timestampProvider"><timestampProvider></a></b></h4> |
| |
| <div> |
| <p>Role hint of a custom build timestamp provider.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.lang.String</li> |
| |
| <li><b>Since</b>: 0.16.0</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright © 2008–2020<a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| .</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
