| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.1 from target/generated-site/xdoc/assemble-repository-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 p2 Repository Plugin – tycho-p2-repository:assemble-repository</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 p2 Repository 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-p2-repository:assemble-repository"></a>tycho-p2-repository:assemble-repository</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.tycho:tycho-p2-repository-plugin:1.7.0:assemble-repository</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div> |
| <p>Aggregates content into a p2 repository in |
| ${project.build.directory}/repository.</p> |
| |
| <ol style="list-style-type: decimal"> |
| |
| <li>Copies resources (if any) from |
| ${project.build.outputDirectory} to |
| ${project.build.directory}/repository. This allows to |
| include additional files such as index.html or about |
| files from src/main/resources (or elsewhere) into the |
| p2 repository.</li> |
| |
| <li>The p2 aggregation into |
| ${project.build.directory}/repository runs |
| recursively: it starts with the content published in the current |
| module, and traverses all artifacts that are marked as |
| <i>included</i> in already aggregated artifacts. (The following |
| artifacts can include other artifacts: categories, products, and |
| features. Note: Dependencies with a strict version range, i.e. a |
| range which only matches exactly one version of an artifact, are |
| also considered as inclusions.)</li> |
| </ol> |
| <br /> |
| <br /></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>: package.</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="#compress"><compress></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>Compress the repository index files content.xml and |
| artifacts.xml.</p><br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#createArtifactRepository"><createArtifactRepository></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>By default, this goal creates a p2 repository. Set this to |
| false if only a p2 metadata repository (without the |
| artifact files) shall be created.</p><br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#extraArtifactRepositoryProperties"><extraArtifactRepositoryProperties></a></td> |
| |
| <td>Map</td> |
| |
| <td>-</td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#includeAllDependencies"><includeAllDependencies></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>By default, only (transitive) <i>inclusions</i> of the |
| published artifacts are aggregated. Set this parameter to |
| true to aggregate <i>all transitive |
| dependencies</i>, making the resulting p2 repository |
| self-contained.</p><br /><b>Default value is</b>: false.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#keepNonXzIndexFiles"><keepNonXzIndexFiles></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>If xzCompress is true, whether jar or |
| xml index files should be kept in addition to XZ-compressed index |
| files. This fallback provides backwards compatibility for pre-Mars |
| p2 clients which cannot read XZ-compressed index files.</p><br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#profileProperties"><profileProperties></a></td> |
| |
| <td>Map</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>Additional properties against which p2 filters are evaluated |
| while aggregating.</p><br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#repositoryName"><repositoryName></a></td> |
| |
| <td>String</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>The name attribute stored in the created p2 repository.</p><br /><b>Default value is</b>: ${project.name}.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#xzCompress"><xzCompress></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td> |
| <p>Add XZ-compressed repository index files. XZ offers better |
| compression ratios esp. for highly redundant file content.</p><br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3Ccompress.3E"></a><b><a name="compress"><compress></a></b></h4> |
| |
| <div> |
| <p>Compress the repository index files content.xml and |
| artifacts.xml.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CcreateArtifactRepository.3E"></a><b><a name="createArtifactRepository"><createArtifactRepository></a></b></h4> |
| |
| <div> |
| <p>By default, this goal creates a p2 repository. Set this to |
| false if only a p2 metadata repository (without the |
| artifact files) shall be created.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CextraArtifactRepositoryProperties.3E"></a><b><a name="extraArtifactRepositoryProperties"><extraArtifactRepositoryProperties></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.util.Map</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeAllDependencies.3E"></a><b><a name="includeAllDependencies"><includeAllDependencies></a></b></h4> |
| |
| <div> |
| <p>By default, only (transitive) <i>inclusions</i> of the |
| published artifacts are aggregated. Set this parameter to |
| true to aggregate <i>all transitive |
| dependencies</i>, making the resulting p2 repository |
| self-contained.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: false</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CkeepNonXzIndexFiles.3E"></a><b><a name="keepNonXzIndexFiles"><keepNonXzIndexFiles></a></b></h4> |
| |
| <div> |
| <p>If xzCompress is true, whether jar or |
| xml index files should be kept in addition to XZ-compressed index |
| files. This fallback provides backwards compatibility for pre-Mars |
| p2 clients which cannot read XZ-compressed index files.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CprofileProperties.3E"></a><b><a name="profileProperties"><profileProperties></a></b></h4> |
| |
| <div> |
| <p>Additional properties against which p2 filters are evaluated |
| while aggregating.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.util.Map</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CrepositoryName.3E"></a><b><a name="repositoryName"><repositoryName></a></b></h4> |
| |
| <div> |
| <p>The name attribute stored in the created p2 repository.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.lang.String</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: ${project.name}</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CxzCompress.3E"></a><b><a name="xzCompress"><xzCompress></a></b></h4> |
| |
| <div> |
| <p>Add XZ-compressed repository index files. XZ offers better |
| compression ratios esp. for highly redundant file content.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</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> |
