Skip to content

Latest commit

 

History

History
667 lines (588 loc) · 22.3 KB

appimage.adoc

File metadata and controls

667 lines (588 loc) · 22.3 KB
Raw

AppImage

AppImage provides a way for upstream developers to provide “native” binaries for Linux users just the same way they could do for other operating systems.

We recommend reading the Upstream Metadata documentation as AppImage depends on it.

The following artifact extensions are supported by this packager:

  • .tgz

  • .txz

  • .tar.gz

  • .tar.xz

  • .tar

  • .zip

Distribution Support

Distribution Supported

concepts:distributions/binary.adoc

{icon_req_y}

concepts:distributions/flat-binary.adoc

{icon_req_y}

concepts:distributions/java-binary.adoc

{icon_req_y}

concepts:distributions/jlink.adoc

{icon_req_y}

concepts:distributions/native-image.adoc

{icon_req_y}

concepts:distributions/native-package.adoc

{icon_req_n}

concepts:distributions/single-jar.adoc

{icon_req_y}
Warning
 Publication of snapshots is not allowed.
YAML
partial$packagers/yaml/common-head.adoc

partial$packagers/yaml/template-directory.adoc

partial$packagers/yaml/commitauthor.adoc

partial$packagers/yaml/tap.adoc

    # Unique identifier for this component.
    # See <id>
    # [exclamation triangle]
    componentId: com.acme.app

    # The categories this software component is associated with
    # See <categories>
    # [exclamation triangle]
    categories:
      - Development

    # Represent the developers or project responsible for development of the project.
    # See <developer_name>
    # Defaults to the project's authors separated by comma.
    # [icon:dot circle]
    developerName: Duke

    # Indicates if the executable requires access to the terminal.
    # Defaults to true if the distribution's stereotype is `CLI`.
    # [icon:dot circle]
    requestTerminal: false

    # Releases to be skipped from the list of releases.
    # Values may be either an exact version match or a regex.
    # [icon:dot circle]
    skipReleases:
      - 1.2.3
      - .*-.*

    # A list of screenshots.
    # If undefined, defaults to `${project.screenshots}`.
    # [dot circle]
    screenshots:
        # Publicly available URL. PNG format is preferred.
        # [exclamation triangle] [file alt]
      - url: https://acme.com/app.png
        # The type of image.
        # Valid values are [`SOURCE`, `THUMBNAIL`].
        # Defaults to `SOURCE`.
        # [dot circle]
        type: THUMBNAIL
        # Marks this screenshot as the primary one.
        # Only a single screenshot may be set as primary.
        # [dot circle]
        primary: true
        # A description of the image.
        # Should be no more than 100 characters long.
        # [dot circle]
        caption: App in action
        # Image width in pixels.
        # Required if type = `THUMBNAIL`.
        # [dot circle]
        width: 250
        # Image height in pixels.
        # Required if type = `THUMBNAIL`.
        # [dot circle]
        height: 250
        # Additional properties used when evaluating templates.
        # [dot circle] [file alt]
        extraProperties:
          # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
          foo: bar

    # A list of icons.
    # If undefined, defaults to `${project.icons}`.
    # [dot circle]
    icons:
        # Publicly available URL. PNG format is preferred.
        # [exclamation triangle] [file alt]
      - url: https://acme.com/app.png
        # Marks this icon as the primary one.
        # Only a single icon may be set as primary.
        # [dot circle]
        primary: true
        # Image width in pixels.
        # [exclamation triangle]
        width: 250
        # Image height in pixels.
        # [exclamation triangle]
        height: 250
        # Additional properties used when evaluating templates.
        # [dot circle] [file alt]
        extraProperties:
          # Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
          foo: bar
TOML
partial$packagers/toml/common-head.adoc

partial$packagers/toml/template-directory.adoc

partial$packagers/toml/commitauthor.adoc

partial$packagers/toml/tap.adoc

  # Unique identifier for this component.
  # See <id>
  # [exclamation triangle]
  componentId = "com.acme.app"

  # The categories this software component is associated with
  # See <categories>
  # [exclamation triangle]
  categories = ["Development"]

  # Represent the developers or project responsible for development of the project.
  # See <developer_name>
  # Defaults to the project's authors separated by comma.
  # [icon:dot circle]
  developerName = "Duke"

  # Indicates if the executable requires access to the terminal.
  # Defaults to true if the distribution's stereotype is `CLI`.
  # [icon:dot circle]
  requestTerminal = false

  # Releases to be skipped from the list of releases.
  # Values may be either an exact version match or a regex.
  # [icon:dot circle]
  skipReleases = ["1.2.3", ".*-.*"]

  # A list of screenshots.
  # If undefined, defaults to `${project.screenshots}`.
  # [dot circle]
  [[packagers.appImage.screenshots]]
    # Publicly available URL. PNG format is preferred.
    # [exclamation triangle] [file alt]
    url = "https://acme.com/app.png"
    # The type of image.
    # Valid values are [`SOURCE`, `THUMBNAIL`].
    # Defaults to `SOURCE`.
    # [dot circle]
    type = "THUMBNAIL"
    # Marks this screenshot as the primary one.
    # Only a single screenshot may be set as primary.
    # [dot circle]
    primary = true
    # A description of the image.
    # Should be no more than 100 characters long.
    # [dot circle]
    caption = "App in action"
    # Image width in pixels.
    # Required if type = `THUMBNAIL`.
    # [dot circle]
    width = 250
    # Image height in pixels.
    # Required if type = `THUMBNAIL`.
    # [dot circle]
    height = 250
    # Additional properties used when evaluating templates.
    # [dot circle] [file alt]
    extraProperties.foo = "bar"
    # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.

  # A list of icons.
  # If undefined, defaults to `${project.icons}`.
  # [dot circle]
  [[packagers.appImage.icons]]
    # Publicly available URL. PNG format is preferred.
    # [exclamation triangle] [file alt]
    url = "https://acme.com/app.png"
    # Marks this icon as the primary one.
    # Only a single icon may be set as primary.
    # [dot circle]
    primary = true
    # Image width in pixels.
    # [exclamation triangle]
    width = 250
    # Image height in pixels.
    # [exclamation triangle]
    height = 250
    # Additional properties used when evaluating templates.
    # [dot circle] [file alt]
    extraProperties.foo = "bar"
    # Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
JSON
partial$packagers/json/common-head.adoc

partial$packagers/json/template-directory.adoc

partial$packagers/json/commitauthor.adoc

partial$packagers/json/tap.adoc

      // Unique identifier for this component.
      // See <id>
      // [exclamation triangle]
      "componentId": "com.acme.app",

      // The categories this software component is associated with
      // See <categories>
      // [exclamation triangle]
      "categories": [
        "Development"
      ],

      // Represent the developers or project responsible for development of the project.
      // See <developer_name>
      // Defaults to the project's authors separated by comma.
      // [icon:dot circle]
      "developerName": "Duke",

      // Indicates if the executable requires access to the terminal.
      // Defaults to true if the distribution's stereotype is `CLI`.
      // [icon:dot circle]
      "requestTerminal": false,

      // Releases to be skipped from the list of releases.
      // Values may be either an exact version match or a regex.
      // [icon:dot circle]
      "skipReleases": [
        "1.2.3",
        ".*-.*"
      ],

      // A list of screenshots.
      // If undefined, defaults to `${project.screenshots}`.
      // [dot circle]
      screenshots: [
        {
          // Publicly available URL. PNG format is preferred.
          // [exclamation triangle] [file alt]
          "url": "https://acme.com/app.png",
          // The type of image.
          // Valid values are [`SOURCE`, `THUMBNAIL`].
          // Defaults to `SOURCE`.
          // [dot circle]
          "type": "THUMBNAIL",
          // Marks this screenshot as the primary one.
          // Only a single screenshot may be set as primary.
          // [dot circle]
          "primary": true,
          // A description of the image.
          // Should be no more than 100 characters long.
          // [dot circle]
          "caption": "App in action",
          // Image width in pixels.
          // Required if type = `THUMBNAIL`.
          // [dot circle]
          "width": 250,
          // Image height in pixels.
          // Required if type = `THUMBNAIL`.
          // [dot circle]
          "height": 250,
          // Additional properties used when evaluating templates.
          // [dot circle] [file alt]
          "extraProperties": {
            // Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
            "foo": "bar"
          }
        }
      ],
      // A list of icons.
      // If undefined, defaults to `${project.icons}`.
      // [dot circle]
      icons: [
        {
          // Publicly available URL. PNG format is preferred.
          // [exclamation triangle] [file alt]
          "url": "https://acme.com/app.png",
          // Marks this icon as the primary one.
          // Only a single icon may be set as primary.
          // [dot circle]
          "primary": true,
          // Image width in pixels.
          // [exclamation triangle]
          "width": 250,
          // Image height in pixels.
          // [exclamation triangle]
          "height": 250,
          // Additional properties used when evaluating templates.
          // [dot circle] [file alt]
          "extraProperties": {
            // Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
            "foo": "bar"
          }
        }
      ]
partial$packagers/json/common-footer.adoc
Maven
partial$packagers/maven/common-head.adoc

partial$packagers/maven/template-directory.adoc

partial$packagers/maven/commitauthor.adoc

partial$packagers/maven/tap.adoc

      <!--
        Unique identifier for this component.
        See <id>
        [exclamation triangle]
      -->
      <componentId>com.acme.app</componentId>

      <!--
        The categories this software component is associated with
        See <categories>
        [exclamation triangle]
      -->
      <categories>
        <category>Development</category>
      </categories>

      <!--
        Represent the developers or project responsible for development of the project.
        See <developer_name>
        Defaults to the project's authors separated by comma.
        [icon:dot circle]
      -->
      <developerName>Duke</developerName>

      <!--
        Indicates if the executable requires access to the terminal.
        Defaults to true if the distribution's stereotype is `CLI`.
        [icon:dot circle]
      -->
      <requestTerminal>false</requestTerminal>

      <!--
        Releases to be skipped from the list of releases.
        Values may be either an exact version match or a regex.
        [icon:dot circle]
      -->
      <skipReleases>
        <skipRelease>1.2.3</skipRelease>
        <skipRelease>.*-.*</skipRelease>
      </skipReleases>

      <!--
        A list of screenshots.
        If undefined, defaults to `${project.screenshots}`.
        [dot circle]
      -->
      <screenshots>
        <screenshot>
          <!--
            Publicly available URL. PNG format is preferred.
            [exclamation triangle] [file alt]
          -->
          <url>https://acme.com/app.png</url>
          <!--
            The type of image.
            Valid values are [`SOURCE`, `THUMBNAIL`].
            Defaults to `SOURCE`.
            [dot circle]
          -->
          <type>THUMBNAIL</type>
          <!--
            Marks this screenshot as the primary one.
            Only a single screenshot may be set as primary.
            [dot circle]
          -->
          <primary>true</primary>
          <!--
            A description of the image.
            Should be no more than 100 characters long.
            [dot circle]
          -->
          <caption>App in action</caption>
          <!--
            Image width in pixels.
            Required if type = `THUMBNAIL`.
            [dot circle]
          -->
          <width>250</width>
          <!--
            Image height in pixels.
            Required if type = `THUMBNAIL`.
            [dot circle]
          -->
          <height>250</height>
          <!--
            Additional properties used when evaluating templates.
            [dot circle] [file alt]
          -->
          <extraProperties>
            <!--
              Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
            -->
            <foo>bar</foo>
          </extraProperties>
        </screenshot>
      </screenshots>

      <!--
        A list of icons.
        If undefined, defaults to `${project.icons}`.
        [dot circle]
      -->
      <icons>
        <icon>
          <!--
            Publicly available URL. PNG format is preferred.
            [exclamation triangle] [file alt]
          -->
          <url>https://acme.com/app.png</url>
          <!--
            Marks this icon as the primary one.
            Only a single icon may be set as primary.
            [dot circle]
          -->
          <primary>true</primary>>
          <!--
            Image width in pixels.
            [exclamation triangle]
          -->
          <width>250</width>
          <!--
            Image height in pixels.
            [exclamation triangle]
          -->
          <height>250</height>
          <!--
            Additional properties used when evaluating templates.
            [dot circle] [file alt]
          -->
          <extraProperties>
            <!--
              Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
            -->
            <foo>bar</foo>
          </extraProperties>
        </icon>
      </icons>
partial$packagers/maven/common-footer.adoc
Gradle
partial$packagers/gradle/common-head.adoc

partial$packagers/gradle/template-directory.adoc

partial$packagers/gradle/commitauthor.adoc

partial$packagers/gradle/tap.adoc

      // Unique identifier for this component.
      // See <id>
      // [exclamation triangle]
      componentId = 'com.acme.app'

      // The categories this software component is associated with
      // See <categories>
      // [exclamation triangle]
      category('Development')

      // Represent the developers or project responsible for development of the project.
      // See <developer_name>
      // Defaults to the project's authors separated by comma.
      // [icon:dot circle]
      developerName = 'Duke'

      // Indicates if the executable requires access to the terminal.
      // Defaults to true if the distribution's stereotype is `CLI`.
      // [icon:dot circle]
      requestTerminal = false

      // Releases to be skipped from the list of releases.
      // Values may be either an exact version match or a regex.
      // [icon:dot circle]
      skipRelease('1.2.3')
      skipRelease('.*-.*')

      // A list of screenshots.
      // If undefined, defaults to `${project.screenshots}`.
      // [dot circle]
      screenshot {
        // Publicly available URL. PNG format is preferred.
        // [exclamation triangle] [file alt]
        url = 'https://acme.com/app.png'
        // The type of image.
        // Valid values are [`SOURCE`, `THUMBNAIL`].
        // Defaults to `SOURCE`.
        // [dot circle]
        screenshotType = THUMBNAIL
        // Marks this screenshot as the primary one.
        // Only a single screenshot may be set as primary.
        // [dot circle]
        primary = true
        // A description of the image.
        // Should be no more than 100 characters long.
        // [dot circle]
        caption = 'App in action'
        // Image width in pixels.
        // Required if type = `THUMBNAIL`.
        // [dot circle]
        width = 250
        // Image height in pixels.
        // Required if type = `THUMBNAIL`.
        // [dot circle]
        height = 250
        // Additional properties used when evaluating templates.
        // Key will be capitalized and prefixed with `screenshot`, i.e, `screenshot`.
        // [dot circle] [file alt]
        extraProperties.put('foo', 'bar')
      }

      // A list of icons.
      // If undefined, defaults to `${project.icons}`.
      // [dot circle]
      icon {
        // Publicly available URL. PNG format is preferred.
        // [exclamation triangle] [file alt]
        url = 'https://acme.com/app.png'
        // Marks this icon as the primary one.
        // Only a single icon may be set as primary.
        // [dot circle]
        primary = true
        // Image width in pixels.
        // [exclamation triangle]
        width = 250
        // Image height in pixels.
        // [exclamation triangle]
        height = 250
        // Additional properties used when evaluating templates.
        // Key will be capitalized and prefixed with `icon`, i.e, `icon`.
        // [dot circle] [file alt]
        extraProperties.put('foo', 'bar')
      }
partial$packagers/gradle/common-footer.adoc

Icon

You must define at least one icon. A square (128x128 pixels) image in PNG format is preferred.

Skip Artifacts

If there is more than one matching artifact in a given distribution you may add a skipAppImage extra property to the target artifact to mark it as skipped for packaging with AppImage.

Skip Screenshots

You may add a skipAppImage extra property to a target screenshot to mark it as skipped for packaging with AppImage.

Skip Icons

You may add a skipAppImage extra property to a target icon to mark it as skipped for packaging with AppImage.

Templates

The default location for templates is:

src/jreleaser/distributions/<distribution-name>/appimage

The following list shows the filenames that may be used to override default templates:

  • .github/workflows/release.yml.tpl

  • icons/app.png

  • cli-app.desktop.tpl

  • cli-appdata.xml.tpl

  • create-appimage.sh.tpl

  • desktop-app.desktop.tpl

  • desktop-appdata.xml.tpl

  • jreleaser.yml.tpl

  • README-github.adoc.tpl

  • VERSION.tpl

  • launcher.tpl (only for distributions of type concepts:distributions/single-jar.adoc)

Any additional files found in the template directories will be copied as is unless their filename ends with .tpl in which case name-templates.adoc substitution will take place.

Templates may be initialized using the template command

{icon_cli_s} template, {icon_maven_s} jreleaser:template, {icon_gradle_s} jreleaserTemplate, {icon_ant_s} jreleaser-template

Skip Templates

You may skip any template files by defining a set of skip rules in the skipTemplates property. For example, you may use any of these expressions to skip a template named README.md.tpl:

  • README.md.tpl: matches the full template name

  • README.md: matches the transformed template name

  • README.*: matches using a regex