| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/assemble-maven-repository-mojo.xml at 2022-02-28 |
| | Rendered using Apache Maven Fluido Skin 1.10.0 |
| --> |
| <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.11.1" /> |
| <title>Tycho p2 Repository Plugin – tycho-p2-repository:assemble-maven-repository</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.10.0.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.10.0.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: 2022-02-28<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.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="../../target-platform-configuration/plugin-info.html" title="Target Platform Configuration"><span class="none"></span>Target Platform Configuration</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-maven-repository"></a>tycho-p2-repository:assemble-maven-repository</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.tycho:tycho-p2-repository-plugin:2.7.0:assemble-maven-repository</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div> |
| <p>This goals produces a "p2-maven-site" from the projects declared |
| <dependencies> (and <dependencyManagement> if desired). |
| A p2-maven-site is completely manageable by standard maven tools |
| and has the following properties:</p> |
| |
| <ul> |
| |
| <li>The artifacts are not stored in the site itself but referenced |
| as maven-coordinates, that means you don't have to upload your |
| artifacts to a dedicated place, everything is fetched from the |
| maven repository</li> |
| |
| <li>The metadata of the page is attached to the current project |
| with type=zip and classifier=p2site and could be deployed using |
| standard maven techniques</li> |
| </ul> |
| <b>Please note:</b> Only valid OSGi bundles are included, there is |
| no way to automatically wrap plain jars and they are silently |
| ignored. This is intentional, as the goal of a p2-maven-site is to |
| use exactly the same artifact that is deployed in the maven |
| repository. <br /> |
| <br /> |
| |
| |
| <p>The produced p2-maven-site can then be consumed by Tycho or PDE |
| targets (m2eclipse is required for this), in the following way: A |
| tycho-repository section:</p> |
| |
| <div> |
| <pre> |
| <repository> |
| <id>my-p2-maven-site</id> |
| <url>mvn:[grouId]:[artifactId]:[version]:zip:p2site</url> |
| <layout>p2</layout> |
| </repository> |
| </pre></div> |
| |
| A target location of type software-site: |
| |
| <div> |
| <pre> |
| <location includeAllPlatforms="false" includeConfigurePhase="true" includeMode="planner" includeSource="true" type="InstallableUnit"> |
| <repository location="mvn:[grouId]:[artifactId]:[version]:zip:p2site"/> |
| -- list desired units here -- |
| </location> |
| </pre></div> |
| |
| <br /> |
| <br /></div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li> |
| |
| <li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> |
| </ul> |
| <section> |
| <h3><a name="Required_Parameters"></a>Required 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 align="left"><code><a href="#buildDirectory"><buildDirectory></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>The output directory of the jar file By default this is the Maven |
| "target/" directory.<br /><b>User property is</b>: <code>project.build.directory</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <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 align="left"><code><a href="#categoryFile"><categoryFile></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Location of the category definition. If the file does not exits, a |
| generic category definition is generated including all bundles |
| under one category<br /><b>Default value is</b>: <code>${project.basedir}/category.xml</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#categoryName"><categoryName></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Name for the automatically generated category<br /><b>Default value is</b>: <code>Bundles</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#destination"><destination></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <code>${project.build.directory}/repository</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#includeDependencies"><includeDependencies></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Flag whether declared <dependencies> of the projects should |
| be included.<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#includeManaged"><includeManaged></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Flag that controls if <dependencyManagement> managed |
| dependencies should be included, this is useful if your are using a |
| BOM and like to include all materials in the update-site regardless |
| of if they are explicitly included in the <dependencies> |
| section<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#includePGPSignature"><includePGPSignature></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If enabled, PGP signatures of the artifacts are embedded in the P2 |
| site to allow for additional verifications / trust decisions<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#includeReactor"><includeReactor></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Flag that controls if reactor projects should be considered, this |
| is useful if your are simply like to make an update side of all |
| your current reactor projects<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#includeTransitiveDependencies"><includeTransitiveDependencies></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Flag whether dependencies of the projects declared |
| <dependencies> (and <dependencyManagement> if desired) |
| should be included. If enabled this creates the maven equivalent of |
| a self-contained P2 site<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#keyServerRetry"><keyServerRetry></a></code></td> |
| |
| <td><code>int</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Key servers are sometimes busy, this configures the maximum amount |
| of retries to fetch the public key before failing the build<br /><b>Default value is</b>: <code>10</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#keyServerUrl"><keyServerUrl></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Configures the key server that is used to fetch the public keys<br /><b>Default value is</b>: <code>http://pgp.mit.edu/pks/lookup?op=get&search={0}</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#timeoutInSeconds"><timeoutInSeconds></a></code></td> |
| |
| <td><code>int</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <code>300</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CbuildDirectory.3E"></a><b><a name="buildDirectory"><buildDirectory></a></b></h4> |
| |
| <div>The output directory of the jar file By default this is the Maven |
| "target/" directory.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>Yes</code></li> |
| |
| <li><b>User Property</b>: <code>project.build.directory</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CcategoryFile.3E"></a><b><a name="categoryFile"><categoryFile></a></b></h4> |
| |
| <div>Location of the category definition. If the file does not exits, a |
| generic category definition is generated including all bundles |
| under one category</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>${project.basedir}/category.xml</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CcategoryName.3E"></a><b><a name="categoryName"><categoryName></a></b></h4> |
| |
| <div>Name for the automatically generated category</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>Bundles</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cdestination.3E"></a><b><a name="destination"><destination></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>${project.build.directory}/repository</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeDependencies.3E"></a><b><a name="includeDependencies"><includeDependencies></a></b></h4> |
| |
| <div>Flag whether declared <dependencies> of the projects should |
| be included.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeManaged.3E"></a><b><a name="includeManaged"><includeManaged></a></b></h4> |
| |
| <div>Flag that controls if <dependencyManagement> managed |
| dependencies should be included, this is useful if your are using a |
| BOM and like to include all materials in the update-site regardless |
| of if they are explicitly included in the <dependencies> |
| section</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludePGPSignature.3E"></a><b><a name="includePGPSignature"><includePGPSignature></a></b></h4> |
| |
| <div>If enabled, PGP signatures of the artifacts are embedded in the P2 |
| site to allow for additional verifications / trust decisions</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeReactor.3E"></a><b><a name="includeReactor"><includeReactor></a></b></h4> |
| |
| <div>Flag that controls if reactor projects should be considered, this |
| is useful if your are simply like to make an update side of all |
| your current reactor projects</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeTransitiveDependencies.3E"></a><b><a name="includeTransitiveDependencies"><includeTransitiveDependencies></a></b></h4> |
| |
| <div>Flag whether dependencies of the projects declared |
| <dependencies> (and <dependencyManagement> if desired) |
| should be included. If enabled this creates the maven equivalent of |
| a self-contained P2 site</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CkeyServerRetry.3E"></a><b><a name="keyServerRetry"><keyServerRetry></a></b></h4> |
| |
| <div>Key servers are sometimes busy, this configures the maximum amount |
| of retries to fetch the public key before failing the build</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>int</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>10</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CkeyServerUrl.3E"></a><b><a name="keyServerUrl"><keyServerUrl></a></b></h4> |
| |
| <div>Configures the key server that is used to fetch the public keys</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>http://pgp.mit.edu/pks/lookup?op=get&search={0}</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtimeoutInSeconds.3E"></a><b><a name="timeoutInSeconds"><timeoutInSeconds></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>int</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>300</code></li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2008–2022 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| <script> |
| if(anchors) { |
| anchors.add(); |
| } |
| </script> |
| </body> |
| </html> |
