blob: 3e5fc02b363e94c6ee9b65c6bd912256518d8a5c [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/compare-version-with-baselines-mojo.xml at 2020-08-03
| Rendered using Apache Maven Fluido Skin 1.9
-->
<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.2" />
<title>Tycho p2 Extras Plugin &#x2013; tycho-p2-extras:compare-version-with-baselines</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.9.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.9.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<header>
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Tycho p2 Extras 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-08-03<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 2.0.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-p2-extras:compare-version-with-baselines"></a>tycho-p2-extras:compare-version-with-baselines</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho.extras:tycho-p2-extras-plugin:2.0.0:compare-version-with-baselines</p>
<p><b>Description</b>:</p>
<div>This mojo compares versions the output artifacts of your module
build with the version of the same artifacts available in
configured baselines, in order to detect version inconsistencies
(version moved back, or not correctly bumped since last release).
Rules for &quot;illegal&quot; versions are:
<ul class="noindent">
<li>version decreased compared to baseline</li>
<li>same fully-qualified version as baseline, but with different
binary content</li>
<li>same major.minor.micro as baseline, with different qualifier
(at least micro should be increased)</li>
<li style="list-style: none">This mojo doesn't allow to use
qualifier as a versioning segment and will most likely drive to
false-positive errors if your qualifier has means to show
versioniterations.</li>
</ul></div>
<p><b>Attributes</b>:</p>
<ul>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>verify</code>.</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><code><a href="#baselines">&lt;baselines&gt;</a></code></td>
<td><code>List</code></td>
<td><code>-</code></td>
<td>A list of p2 repositories to be used as baseline. Those are
typically the most recent released versions of your project.<br /><b>User property is</b>: <code>baselines</code>.<br /></td>
</tr>
<tr class="a">
<td><code><a href="#onIllegalVersion">&lt;onIllegalVersion&gt;</a></code></td>
<td><code>CompareWithBaselineMojo$ReportBehavior</code></td>
<td><code>-</code></td>
<td>(no description)<br /><b>Default value is</b>: <code>fail</code>.<br /><b>User property is</b>: <code>onIllegalVersion</code>.<br /></td>
</tr>
<tr class="b">
<td><code><a href="#skip">&lt;skip&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>(no description)<br /><b>User property is</b>: <code>skip</code>.<br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<section>
<h4><a name="a.3Cbaselines.3E"></a><b><a name="baselines">&lt;baselines&gt;</a></b></h4>
<div>A list of p2 repositories to be used as baseline. Those are
typically the most recent released versions of your project.</div>
<ul>
<li><b>Type</b>: <code>java.util.List</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>baselines</code></li>
</ul><hr /></section><section>
<h4><a name="a.3ConIllegalVersion.3E"></a><b><a name="onIllegalVersion">&lt;onIllegalVersion&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <code>org.eclipse.tycho.plugins.p2.extras.CompareWithBaselineMojo$ReportBehavior</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>onIllegalVersion</code></li>
<li><b>Default</b>: <code>fail</code></li>
</ul><hr /></section><section>
<h4><a name="a.3Cskip.3E"></a><b><a name="skip">&lt;skip&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <code>boolean</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>skip</code></li>
</ul>
</section></section>
</section>
</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>&#169; 2008&#x2013;2020
<a href="http://www.eclipse.org/">Eclipse Foundation</a>
</p>
</div>
</div>
</footer>
</body>
</html>