eclipse-flatpak-packager:package-flatpak

Full name:

org.eclipse.cbi.maven.plugins:eclipse-flatpak-packager:1.1.5:package-flatpak

Description:

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.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.1.5.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
<branch> String 1.1.5 The branch of the application, defaults to "master" but can be set to identify the stream, for example: "Oxygen" or "4.7"
Default value is: master.
<command> String 1.1.5 The filename or path to the main binary of the application, defaults to "eclipse"
Default value is: eclipse.
<description> String 1.1.5 A longer description of the Flatpak application that may be shown in distro software centres.
<id> String 1.1.5 A unique identifier for the Flatpak application, for example: "org.eclipse.Platform"
<license> String 1.1.5 The license that the Flatpak application is distributed under. It should be a valid SPDX license expression. For example:
  • EPL-1.0
  • Apache-2.0 AND LGPL-3.0-or-later

A full list of recognized licenses and their identifiers can be found at the SPDX OpenSource License Registry.


Default value is: EPL-1.0.
<minFlatpakVersion> String 1.1.5 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)
Default value is: 0.8.8.
<name> String 1.1.5 A friendly name for the Flatpak application that will be shown to use in software centres and in desktop environments.
<runtimeVersion> String 1.1.5 The version of the Gnome runtime on which to build the Flatpak application. Defaults to "3.28"
Default value is: 3.28.
<source> File 1.1.5 An .tar.gz or .zip file containing a Linux product from which to generate a Flatpak application.
<summary> String 1.1.5 A short description of the Flatpak application that may be shown in distro software centres and in desktop environments.

Optional Parameters

Name Type Since Description
<additionalSources> List 1.1.5 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: 
<additionalSources>
        <additionalSource>
                <source>/path/to/local/file</source>
                <destination>/path/to/location/inside/the/sandbox</destination>
        </additionalSources>
</additionalSources>

<continueOnFail> boolean 1.1.5 Whether the build should be stopped if the packaging process fails.
Default value is: false.
User property is: cbi.flatpakager.continueOnFail.
<gpgHome> File 1.1.5 The location of the GPG secure keyring to use when signing the Flatpak application. Defaults to the ".gnupg" directory in the user's home.
User property is: cbi.flatpakager.gpghome.
<gpgKey> String 1.1.5 The GPG key to use when signing the Flatpak application.
User property is: cbi.flatpakager.gpgkey.
<maintainer> String 1.1.5 An optional email address that can be used to contact the project about invalid or incomplete metadata.
<repository> File 1.1.5 The repository to which the new Flatpak application should be exported. If not specified, a new repository will be created inside the build directory.
User property is: cbi.flatpakager.repo.
<repositoryUrl> String 1.1.5 The URL at which the Flatpak repository will be available to users, this is embedded into generated "flatpakrepo" and "flatpakref" files.
Default value is: http://www.example.com/flatpak/repo.
User property is: cbi.flatpakager.repoUrl.
<screenshots> List 1.1.5 An optional list of URLs to screenshots that may be shown in distro software centres.
<serviceUrl> String 1.1.5 An optional URL for the Flatpak application packaging web service.

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:

http://build.eclipse.org:31338/flatpak-packager


User property is: cbi.flatpakager.serviceUrl.
<sign> boolean 1.1.5 Whether the Flatpak application should be GPG signed.
Default value is: false.
User property is: cbi.flatpakager.sign.
<skip> boolean 1.1.5 Skips the execution of this plugin.
Default value is: false.
User property is: cbi.flatpakager.skip.
<timeoutMillis> int 1.1.5 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 serviceUrl is specified.
Default value is: 0.
User property is: cbi.flatpakager.timeoutMillis.

Parameter Details

<additionalSources>

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: 
<additionalSources>
        <additionalSource>
                <source>/path/to/local/file</source>
                <destination>/path/to/location/inside/the/sandbox</destination>
        </additionalSources>
</additionalSources>
  • Type: java.util.List
  • Since: 1.1.5
  • Required: No

<branch>

The branch of the application, defaults to "master" but can be set to identify the stream, for example: "Oxygen" or "4.7"
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes
  • Default: master

<command>

The filename or path to the main binary of the application, defaults to "eclipse"
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes
  • Default: eclipse

<continueOnFail>

Whether the build should be stopped if the packaging process fails.
  • Type: boolean
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.continueOnFail
  • Default: false

<description>

A longer description of the Flatpak application that may be shown in distro software centres.
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes

<gpgHome>

The location of the GPG secure keyring to use when signing the Flatpak application. Defaults to the ".gnupg" directory in the user's home.
  • Type: java.io.File
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.gpghome

<gpgKey>

The GPG key to use when signing the Flatpak application.
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.gpgkey

<id>

A unique identifier for the Flatpak application, for example: "org.eclipse.Platform"
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes

<license>

The license that the Flatpak application is distributed under. It should be a valid SPDX license expression. For example:
  • EPL-1.0
  • Apache-2.0 AND LGPL-3.0-or-later

A full list of recognized licenses and their identifiers can be found at the SPDX OpenSource License Registry.

  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes
  • Default: EPL-1.0

<maintainer>

An optional email address that can be used to contact the project about invalid or incomplete metadata.
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: No

<minFlatpakVersion>

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)
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes
  • Default: 0.8.8

<name>

A friendly name for the Flatpak application that will be shown to use in software centres and in desktop environments.
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes

<repository>

The repository to which the new Flatpak application should be exported. If not specified, a new repository will be created inside the build directory.
  • Type: java.io.File
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.repo

<repositoryUrl>

The URL at which the Flatpak repository will be available to users, this is embedded into generated "flatpakrepo" and "flatpakref" files.
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.repoUrl
  • Default: http://www.example.com/flatpak/repo

<runtimeVersion>

The version of the Gnome runtime on which to build the Flatpak application. Defaults to "3.28"
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes
  • Default: 3.28

<screenshots>

An optional list of URLs to screenshots that may be shown in distro software centres.
  • Type: java.util.List
  • Since: 1.1.5
  • Required: No

<serviceUrl>

An optional URL for the Flatpak application packaging web service.

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:

http://build.eclipse.org:31338/flatpak-packager

  • Type: java.lang.String
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.serviceUrl

<sign>

Whether the Flatpak application should be GPG signed.
  • Type: boolean
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.sign
  • Default: false

<skip>

Skips the execution of this plugin.
  • Type: boolean
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.skip
  • Default: false

<source>

An .tar.gz or .zip file containing a Linux product from which to generate a Flatpak application.
  • Type: java.io.File
  • Since: 1.1.5
  • Required: Yes

<summary>

A short description of the Flatpak application that may be shown in distro software centres and in desktop environments.
  • Type: java.lang.String
  • Since: 1.1.5
  • Required: Yes

<timeoutMillis>

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 serviceUrl is specified.
  • Type: int
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.flatpakager.timeoutMillis
  • Default: 0