| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.8 from target/generated-site/xdoc/package-flatpak-mojo.xml at 2018-04-12 |
| | Rendered using Apache Maven Fluido Skin 1.7 |
| --> |
| <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="20180412" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>eclipse-flatpak-packager – eclipse-flatpak-packager:package-flatpak</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.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.7.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><a href="https://eclipse.org" id="bannerLeft"><img src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse.png" alt="Eclipse"/></a></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2018-04-12<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.1.5</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">CBI Maven Plugins</li> |
| <li><a href="../index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../eclipse-jarsigner-plugin/plugin-info.html" title="Jar Signer"><span class="none"></span>Jar Signer</a></li> |
| <li><a href="../eclipse-winsigner-plugin/plugin-info.html" title="Windows Exe Signer"><span class="none"></span>Windows Exe Signer</a></li> |
| <li><a href="../eclipse-macsigner-plugin/plugin-info.html" title="macOS App Signer"><span class="none"></span>macOS App Signer</a></li> |
| <li><a href="../eclipse-dmg-packager/plugin-info.html" title="macOS DMG Packager"><span class="none"></span>macOS DMG Packager</a></li> |
| <li><a href="../eclipse-flatpak-packager/plugin-info.html" title="Linux Flatpak Packager"><span class="none"></span>Linux Flatpak Packager</a></li> |
| <li><a href="../eclipse-cbi-plugin/plugin-info.html" title="Utilities"><span class="none"></span>Utilities</a></li> |
| </ul> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <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="span10" > |
| |
| |
| <div class="section"> |
| <h2><a name="eclipse-flatpak-packager:package-flatpak"></a>eclipse-flatpak-packager:package-flatpak</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.cbi.maven.plugins:eclipse-flatpak-packager:1.1.5:package-flatpak</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Create a Flatpak application from the archived product output of |
| the tycho-p2-director-plugin and exports the application to a |
| Flatpak repository. Signing the Flatpak repository is optional, but |
| highly recommended.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Since version: <tt>1.1.5</tt>.</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>package</tt>.</li> |
| </ul> |
| |
| <div class="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><tt><a href="#branch"><branch></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The branch of the application, defaults to "master" but can be set |
| to identify the stream, for example: "Oxygen" or "4.7"<br /><b>Default value is</b>: <tt>master</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#command"><command></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The filename or path to the main binary of the application, |
| defaults to "eclipse"<br /><b>Default value is</b>: <tt>eclipse</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#description"><description></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>A longer description of the Flatpak application that may be shown |
| in distro software centres.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#id"><id></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>A unique identifier for the Flatpak application, for example: |
| "org.eclipse.Platform"<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#license"><license></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The license that the Flatpak application is distributed under. It |
| should be a valid <a class="externalLink" href="https://spdx.org/specifications">SPDX |
| license expression</a>. For example: |
| |
| <ul> |
| |
| <li><tt>EPL-1.0</tt></li> |
| |
| <li><tt>Apache-2.0 AND LGPL-3.0-or-later</tt></li> |
| </ul> |
| |
| <p>A full list of recognized licenses and their identifiers can be |
| found at the <a class="externalLink" href="https://spdx.org/licenses/">SPDX OpenSource |
| License Registry</a>.</p><br /><b>Default value is</b>: <tt>EPL-1.0</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#minFlatpakVersion"><minFlatpakVersion></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The minimum version of Flatpak needed at runtime, that this |
| application will support. Defaults to "0.8.8" (the version |
| available on RHEL 7.5)<br /><b>Default value is</b>: <tt>0.8.8</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#name"><name></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>A friendly name for the Flatpak application that will be shown to |
| use in software centres and in desktop environments.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#runtimeVersion"><runtimeVersion></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The version of the Gnome runtime on which to build the Flatpak |
| application. Defaults to "3.28"<br /><b>Default value is</b>: <tt>3.28</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#source"><source></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>An <tt>.tar.gz</tt> or <tt>.zip</tt> file containing a |
| Linux product from which to generate a Flatpak application.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#summary"><summary></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>A short description of the Flatpak application that may be shown in |
| distro software centres and in desktop environments.<br /></td> |
| </tr> |
| </table> |
| </div> |
| |
| <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><tt><a href="#additionalSources"><additionalSources></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>An optional list of additional source files that should be |
| installed into the Flatpak application. These files are simply |
| copied into the sandbox at the given location. For example: |
| |
| <div> |
| <pre> |
| <additionalSources> |
| <additionalSource> |
| <source>/path/to/local/file</source> |
| <destination>/path/to/location/inside/the/sandbox</destination> |
| </additionalSources> |
| </additionalSources> |
| </pre></div><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#continueOnFail"><continueOnFail></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>Whether the build should be stopped if the packaging process fails.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cbi.flatpakager.continueOnFail</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#gpgHome"><gpgHome></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The location of the GPG secure keyring to use when signing the |
| Flatpak application. Defaults to the ".gnupg" directory in the |
| user's home.<br /><b>User property is</b>: <tt>cbi.flatpakager.gpghome</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#gpgKey"><gpgKey></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The GPG key to use when signing the Flatpak application.<br /><b>User property is</b>: <tt>cbi.flatpakager.gpgkey</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#maintainer"><maintainer></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>An optional email address that can be used to contact the project |
| about invalid or incomplete metadata.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#repository"><repository></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The repository to which the new Flatpak application should be |
| exported. If not specified, a new repository will be created inside |
| the build directory.<br /><b>User property is</b>: <tt>cbi.flatpakager.repo</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#repositoryUrl"><repositoryUrl></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>The URL at which the Flatpak repository will be available to users, |
| this is embedded into generated "flatpakrepo" and "flatpakref" |
| files.<br /><b>Default value is</b>: <tt>http://www.example.com/flatpak/repo</tt>.<br /><b>User property is</b>: <tt>cbi.flatpakager.repoUrl</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#screenshots"><screenshots></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>An optional list of URLs to screenshots that may be shown in distro |
| software centres.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#serviceUrl"><serviceUrl></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>An optional URL for the Flatpak application packaging web service. |
| |
| <p>By default, the Flatpak application will be generated locally. |
| If the Flatpak tools are unavailable locally, or the build is |
| running on an architecture or OS where Flatpak is not supported, |
| then a URL may be specified that indicated the location of the |
| Flatpak packaging web service. For example:</p> |
| |
| <p>http://build.eclipse.org:31338/flatpak-packager</p><br /><b>User property is</b>: <tt>cbi.flatpakager.serviceUrl</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#sign"><sign></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>Whether the Flatpak application should be GPG signed.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cbi.flatpakager.sign</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#skip"><skip></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>Skips the execution of this plugin.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cbi.flatpakager.skip</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#timeoutMillis"><timeoutMillis></a></tt></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>1.1.5</tt></td> |
| |
| <td>Defines the timeout in milliseconds for any communication with the |
| packaging web service. Defaults to zero, which is interpreted as an |
| infinite timeout. This only means something if a |
| <tt>serviceUrl</tt> is specified.<br /><b>Default value is</b>: <tt>0</tt>.<br /><b>User property is</b>: <tt>cbi.flatpakager.timeoutMillis</tt>.<br /></td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <div class="section"> |
| <h4><a name="a.3CadditionalSources.3E"></a><b><a name="additionalSources"><additionalSources></a></b></h4> |
| |
| <div>An optional list of additional source files that should be |
| installed into the Flatpak application. These files are simply |
| copied into the sandbox at the given location. For example: |
| |
| <div> |
| <pre> |
| <additionalSources> |
| <additionalSource> |
| <source>/path/to/local/file</source> |
| <destination>/path/to/location/inside/the/sandbox</destination> |
| </additionalSources> |
| </additionalSources> |
| </pre></div></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.util.List</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cbranch.3E"></a><b><a name="branch"><branch></a></b></h4> |
| |
| <div>The branch of the application, defaults to "master" but can be set |
| to identify the stream, for example: "Oxygen" or "4.7"</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>master</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Ccommand.3E"></a><b><a name="command"><command></a></b></h4> |
| |
| <div>The filename or path to the main binary of the application, |
| defaults to "eclipse"</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>eclipse</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CcontinueOnFail.3E"></a><b><a name="continueOnFail"><continueOnFail></a></b></h4> |
| |
| <div>Whether the build should be stopped if the packaging process fails.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.continueOnFail</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cdescription.3E"></a><b><a name="description"><description></a></b></h4> |
| |
| <div>A longer description of the Flatpak application that may be shown |
| in distro software centres.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CgpgHome.3E"></a><b><a name="gpgHome"><gpgHome></a></b></h4> |
| |
| <div>The location of the GPG secure keyring to use when signing the |
| Flatpak application. Defaults to the ".gnupg" directory in the |
| user's home.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.gpghome</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CgpgKey.3E"></a><b><a name="gpgKey"><gpgKey></a></b></h4> |
| |
| <div>The GPG key to use when signing the Flatpak application.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.gpgkey</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cid.3E"></a><b><a name="id"><id></a></b></h4> |
| |
| <div>A unique identifier for the Flatpak application, for example: |
| "org.eclipse.Platform"</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Clicense.3E"></a><b><a name="license"><license></a></b></h4> |
| |
| <div>The license that the Flatpak application is distributed under. It |
| should be a valid <a class="externalLink" href="https://spdx.org/specifications">SPDX |
| license expression</a>. For example: |
| |
| <ul> |
| |
| <li><tt>EPL-1.0</tt></li> |
| |
| <li><tt>Apache-2.0 AND LGPL-3.0-or-later</tt></li> |
| </ul> |
| |
| <p>A full list of recognized licenses and their identifiers can be |
| found at the <a class="externalLink" href="https://spdx.org/licenses/">SPDX OpenSource |
| License Registry</a>.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>EPL-1.0</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cmaintainer.3E"></a><b><a name="maintainer"><maintainer></a></b></h4> |
| |
| <div>An optional email address that can be used to contact the project |
| about invalid or incomplete metadata.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CminFlatpakVersion.3E"></a><b><a name="minFlatpakVersion"><minFlatpakVersion></a></b></h4> |
| |
| <div>The minimum version of Flatpak needed at runtime, that this |
| application will support. Defaults to "0.8.8" (the version |
| available on RHEL 7.5)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>0.8.8</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cname.3E"></a><b><a name="name"><name></a></b></h4> |
| |
| <div>A friendly name for the Flatpak application that will be shown to |
| use in software centres and in desktop environments.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Crepository.3E"></a><b><a name="repository"><repository></a></b></h4> |
| |
| <div>The repository to which the new Flatpak application should be |
| exported. If not specified, a new repository will be created inside |
| the build directory.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.repo</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CrepositoryUrl.3E"></a><b><a name="repositoryUrl"><repositoryUrl></a></b></h4> |
| |
| <div>The URL at which the Flatpak repository will be available to users, |
| this is embedded into generated "flatpakrepo" and "flatpakref" |
| files.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.repoUrl</tt></li> |
| |
| <li><b>Default</b>: <tt>http://www.example.com/flatpak/repo</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CruntimeVersion.3E"></a><b><a name="runtimeVersion"><runtimeVersion></a></b></h4> |
| |
| <div>The version of the Gnome runtime on which to build the Flatpak |
| application. Defaults to "3.28"</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>3.28</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cscreenshots.3E"></a><b><a name="screenshots"><screenshots></a></b></h4> |
| |
| <div>An optional list of URLs to screenshots that may be shown in distro |
| software centres.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.util.List</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CserviceUrl.3E"></a><b><a name="serviceUrl"><serviceUrl></a></b></h4> |
| |
| <div>An optional URL for the Flatpak application packaging web service. |
| |
| <p>By default, the Flatpak application will be generated locally. |
| If the Flatpak tools are unavailable locally, or the build is |
| running on an architecture or OS where Flatpak is not supported, |
| then a URL may be specified that indicated the location of the |
| Flatpak packaging web service. For example:</p> |
| |
| <p>http://build.eclipse.org:31338/flatpak-packager</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.serviceUrl</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Csign.3E"></a><b><a name="sign"><sign></a></b></h4> |
| |
| <div>Whether the Flatpak application should be GPG signed.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.sign</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4> |
| |
| <div>Skips the execution of this plugin.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.skip</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Csource.3E"></a><b><a name="source"><source></a></b></h4> |
| |
| <div>An <tt>.tar.gz</tt> or <tt>.zip</tt> file containing a |
| Linux product from which to generate a Flatpak application.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3Csummary.3E"></a><b><a name="summary"><summary></a></b></h4> |
| |
| <div>A short description of the Flatpak application that may be shown in |
| distro software centres and in desktop environments.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CtimeoutMillis.3E"></a><b><a name="timeoutMillis"><timeoutMillis></a></b></h4> |
| |
| <div>Defines the timeout in milliseconds for any communication with the |
| packaging web service. Defaults to zero, which is interpreted as an |
| infinite timeout. This only means something if a |
| <tt>serviceUrl</tt> is specified.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>int</tt></li> |
| |
| <li><b>Since</b>: <tt>1.1.5</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cbi.flatpakager.timeoutMillis</tt></li> |
| |
| <li><b>Default</b>: <tt>0</tt></li> |
| </ul> |
| </div></div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2018 |
| <a href="http://eclipse.org/">Eclipse Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |