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
Configuration
Legend:
-
required
-
optional
-
may use environment variable
-
accepts Name Templates
#
packagers:
#
appImage:
# Enables or disables AppImage.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
#
active: ALWAYS
# Let the release continue if the packager fails.
# Defaults to `false`.
#
continueOnError: true
# Custom download URL.
#
downloadUrl: https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}
# Additional properties used when evaluating templates.
#
extraProperties:
# Key will be capitalized and prefixed with `appImage`, i.e, `appImageFoo`.
foo: bar
# Directory with file templates used to prepare the AppImage distribution.
# Defaults to `src/jreleaser/distributions/#{distribution.name}/appImage`.
# If specified, path must exist.
#
templateDirectory: path/to/appImage/templates
# List of template files to be skipped.
# Value may be an exact match or a regex.
#
skipTemplates:
- README.md.tpl
# Git author used to commit to the repository.
#
commitAuthor:
# Name used when authoring commits.
# Defaults to `jreleaserbot`.
#
name: jreleaserbot
# E-mail used when authoring commits.
# Defaults to `jreleaser@kordamp.org`.
#
email: jreleaser@kordamp.org
# Git repository to push the appdata to.
# Defaults are shown.
#
repository:
# Enables or disables the repository.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `RELEASE`.
#
active: ALWAYS
# The owner of the repository.
# Defaults to the same owner as the release repository.
#
owner: duke
# The name of the repository.
# Defaults to `duke-appimage`.
#
name: duke-appimage
# The tag associated with the appdata.
# If left unspecified, will use `{{tagName}}`.
#
tagName: '{{distributionName}}-{{tagName}}'
# The target branch to pull from.
# Defaults to the branch pointed by HEAD.
#
branch: HEAD
# The target branch to push to.
# Defaults to the branch pointed by `#{branch}`.
#
branchPush: '{{projectName}}-{{tagName}}'
# Username used for authoring commits.
# Must have write access to the repository.
# Defaults to the same username as the release repository.
#
username: duke
# Password or OAuth token with write access to the repository.
#
token: __USE_ENVIRONMENT_VARIABLE__
# Message when committing to the repository.
# If left unspecified, `{{distributionName}} {{tagName}}` will be used.
#
commitMessage: '{{distributionName}} {{tagName}}'
# Unique identifier for this component.
# See <id>
#
componentId: com.acme.app
# The categories this software component is associated with
# See <categories>
#
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.
#
developerName: Duke
# Indicates if the executable requires access to the terminal.
# Defaults to true if the distribution's stereotype is `CLI`.
#
requestTerminal: false
# Releases to be skipped from the list of releases.
# Values may be either an exact version match or a regex.
#
skipReleases:
- 1.2.3
- .*-.*
# A list of screenshots.
# If undefined, defaults to `#{project.screenshots}`.
#
screenshots:
# Publicly available URL. PNG format is preferred.
#
- url: https://acme.com/app.png
# The type of image.
# Valid values are [`SOURCE`, `THUMBNAIL`].
# Defaults to `SOURCE`.
#
type: THUMBNAIL
# Marks this screenshot as the primary one.
# Only a single screenshot may be set as primary.
#
primary: true
# A description of the image.
# Should be no more than 100 characters long.
#
caption: App in action
# Image width in pixels.
# Required if type = `THUMBNAIL`.
#
width: 250
# Image height in pixels.
# Required if type = `THUMBNAIL`.
#
height: 250
# Additional properties used when evaluating templates.
#
extraProperties:
# Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
foo: bar
# A list of icons.
# If undefined, defaults to `#{project.icons}`.
#
icons:
# Publicly available URL. PNG format is preferred.
#
- url: https://acme.com/app.png
# Marks this icon as the primary one.
# Only a single icon may be set as primary.
#
primary: true
# Image width in pixels.
#
width: 250
# Image height in pixels.
#
height: 250
# Additional properties used when evaluating templates.
#
extraProperties:
# Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
foo: bar
#
[packagers.appImage]
# Enables or disables AppImage.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
#
active = "ALWAYS"
# Let the release continue if the packager fails.
# Defaults to `false`.
#
continueOnError = true
# Custom download URL.
#
downloadUrl = "https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}"
# Additional properties used when evaluating templates.
#
extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `appImage`, i.e, `appImageFoo`.
# Directory with file templates used to prepare the AppImage distribution.
# Defaults to `src/jreleaser/distributions/#{distribution.name}/appImage`.
# If specified, path must exist.
#
templateDirectory = "path/to/appImage/templates"
# List of template files to be skipped.
# Value may be an exact match or a regex.
#
skipTemplates = [ "README.md.tpl" ]
# Git author used to commit to the repository.
# Name used when authoring commits.
# Defaults to `jreleaserbot`.
#
commitAuthor.name = "jreleaserbot"
# E-mail used when authoring commits.
# Defaults to `jreleaser@kordamp.org`.
#
commitAuthor.email = "jreleaser@kordamp.org"
# Git repository to push the appdata to.
# Defaults are shown.
# Enables or disables the repository.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `RELEASE`.
#
repository.active = "ALWAYS"
# The owner of the repository.
# Defaults to the same owner as the release repository.
#
repository.owner = "duke"
# The name of the repository.
# Defaults to `duke-appimage`.
#
repository.name = "duke-appimage"
# The tag associated with the appdata.
# If left unspecified, will use `{{tagName}}`.
#
repository.tagName = "{{distributionName}}-{{tagName}}"
# The target branch to pull from.
# Defaults to the branch pointed by HEAD.
#
repository.branch = "HEAD"
# The target branch to push to.
# Defaults to the branch pointed by `#{branch}`.
#
repository.branchPush = "{{projectName}}-{{tagName}}"
# Username used for authoring commits.
# Must have write access to the repository.
# Defaults to the same username as the release repository.
#
repository.username = "duke"
# Password or OAuth token with write access to the repository.
#
repository.token = "__USE_ENVIRONMENT_VARIABLE__"
# Message when committing to the repository.
# If left unspecified, `{{distributionName}} {{tagName}}` will be used.
#
repository.commitMessage = "{{distributionName}} {{tagName}}"
# Unique identifier for this component.
# See <id>
#
componentId = "com.acme.app"
# The categories this software component is associated with
# See <categories>
#
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.
#
developerName = "Duke"
# Indicates if the executable requires access to the terminal.
# Defaults to true if the distribution's stereotype is `CLI`.
#
requestTerminal = false
# Releases to be skipped from the list of releases.
# Values may be either an exact version match or a regex.
#
skipReleases = ["1.2.3", ".*-.*"]
# A list of screenshots.
# If undefined, defaults to `#{project.screenshots}`.
#
[[packagers.appImage.screenshots]]
# Publicly available URL. PNG format is preferred.
#
url = "https://acme.com/app.png"
# The type of image.
# Valid values are [`SOURCE`, `THUMBNAIL`].
# Defaults to `SOURCE`.
#
type = "THUMBNAIL"
# Marks this screenshot as the primary one.
# Only a single screenshot may be set as primary.
#
primary = true
# A description of the image.
# Should be no more than 100 characters long.
#
caption = "App in action"
# Image width in pixels.
# Required if type = `THUMBNAIL`.
#
width = 250
# Image height in pixels.
# Required if type = `THUMBNAIL`.
#
height = 250
# Additional properties used when evaluating templates.
#
extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
# A list of icons.
# If undefined, defaults to `#{project.icons}`.
#
[[packagers.appImage.icons]]
# Publicly available URL. PNG format is preferred.
#
url = "https://acme.com/app.png"
# Marks this icon as the primary one.
# Only a single icon may be set as primary.
#
primary = true
# Image width in pixels.
#
width = 250
# Image height in pixels.
#
height = 250
# Additional properties used when evaluating templates.
#
extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
{
//
"packagers": {
//
"appImage": {
// Enables or disables AppImage.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
//
"active": "ALWAYS",
// Let the release continue if the packager fails.
// Defaults to `false`.
//
"continueOnError": true,
// Custom download URL.
//
"downloadUrl": "https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}",
// Additional properties used when evaluating templates.
//
"extraProperties": {
// Key will be capitalized and prefixed with `appImage`, i.e, `appImageFoo`.
"foo": "bar"
},
// Directory with file templates used to prepare the AppImage distribution.
// Defaults to `src/jreleaser/distributions/#{distribution.name}/appImage`.
// If specified, path must exist.
//
"templateDirectory": "path/to/appImage/templates",
// List of template files to be skipped.
// Value may be an exact match or a regex.
//
"skipTemplates": [
"README.md.tpl"
],
// Git author used to commit to the repository.
//
"commitAuthor": {
// Name used when authoring commits.
// Defaults to `jreleaserbot`.
//
"name": "jreleaserbot",
// E-mail used when authoring commits.
// Defaults to `jreleaser@kordamp.org`.
//
"email": "jreleaser@kordamp.org"
},
// Git repository to push the appdata to.
// Defaults are shown.
//
"repository": {
// Enables or disables the repository.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `RELEASE`.
//
"active": "ALWAYS",
// The owner of the repository.
// Defaults to the same owner as the release repository.
//
"owner": "duke",
// The name of the repository.
// Defaults to `duke-appimage`.
//
"name": "duke-appimage",
// The tag associated with the appdata.
// If left unspecified, will use `{{tagName}}`.
//
"tagName": "{{distributionName}}-{{tagName}}",
// The target branch to pull from.
// Defaults to the branch pointed by HEAD.
//
"branch": "HEAD",
// The target branch to push to.
// Defaults to the branch pointed by `#{branch}`.
//
"branchPush": "{{projectName}}-{{tagName}}",
// Username used for authoring commits.
// Must have write access to the repository.
// Defaults to the same username as the release repository.
//
"username": "duke",
// Password or OAuth token with write access to the repository.
//
"token": "__USE_ENVIRONMENT_VARIABLE__",
// Message when committing to the repository.
// If left unspecified, `{{distributionName}} {{tagName}}` will be used.
//
"commitMessage": "{{distributionName}} {{tagName}}"
},
// Unique identifier for this component.
// See <id>
//
"componentId": "com.acme.app",
// The categories this software component is associated with
// See <categories>
//
"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.
//
"developerName": "Duke",
// Indicates if the executable requires access to the terminal.
// Defaults to true if the distribution's stereotype is `CLI`.
//
"requestTerminal": false,
// Releases to be skipped from the list of releases.
// Values may be either an exact version match or a regex.
//
"skipReleases": [
"1.2.3",
".*-.*"
],
// A list of screenshots.
// If undefined, defaults to `#{project.screenshots}`.
//
screenshots: [
{
// Publicly available URL. PNG format is preferred.
//
"url": "https://acme.com/app.png",
// The type of image.
// Valid values are [`SOURCE`, `THUMBNAIL`].
// Defaults to `SOURCE`.
//
"type": "THUMBNAIL",
// Marks this screenshot as the primary one.
// Only a single screenshot may be set as primary.
//
"primary": true,
// A description of the image.
// Should be no more than 100 characters long.
//
"caption": "App in action",
// Image width in pixels.
// Required if type = `THUMBNAIL`.
//
"width": 250,
// Image height in pixels.
// Required if type = `THUMBNAIL`.
//
"height": 250,
// Additional properties used when evaluating templates.
//
"extraProperties": {
// Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
"foo": "bar"
}
}
],
// A list of icons.
// If undefined, defaults to `#{project.icons}`.
//
icons: [
{
// Publicly available URL. PNG format is preferred.
//
"url": "https://acme.com/app.png",
// Marks this icon as the primary one.
// Only a single icon may be set as primary.
//
"primary": true,
// Image width in pixels.
//
"width": 250,
// Image height in pixels.
//
"height": 250,
// Additional properties used when evaluating templates.
//
"extraProperties": {
// Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
"foo": "bar"
}
}
]
}
}
}
<jreleaser>
<!--
-->
<packagers>
<!--
-->
<appImage>
<!--
Enables or disables AppImage.
Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
-->
<active>ALWAYS</active>
<!--
Let the release continue if the packager fails.
Defaults to `false`.
-->
<continueOnError>true</continueOnError>
<!--
Custom download URL.
-->
<downloadUrl>https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}</downloadUrl>
<!--
Additional properties used when evaluating templates.
-->
<extraProperties>
<!--
Key will be capitalized and prefixed with `appImage`, i.e, `appImageFoo`.
-->
<foo>bar</foo>
</extraProperties>
<!--
Directory with file templates used to prepare the AppImage distribution.
Defaults to `src/jreleaser/distributions/#{distribution.name}/appImage`.
If specified, path must exist.
-->
<templateDirectory>path/to/appImage/templates</templateDirectory>
<!--
List of template files to be skipped.
Value may be an exact match or a regex.
-->
<skipTemplates>
<skipTemplate>README.md.tpl</skipTemplate>
</skipTemplates>
<!--
Git author used to commit to the repository.
-->
<commitAuthor>
<!--
Name used when authoring commits.
Defaults to `jreleaserbot`.
-->
<name>jreleaserbot</name>
<!--
E-mail used when authoring commits.
Defaults to `jreleaser@kordamp.org`.
-->
<email>jreleaser@kordamp.org</email>
</commitAuthor>
<!--
Git repository to push the appdata to.
Defaults are shown.
-->
<repository>
<!--
Enables or disables the repository.
Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `RELEASE`.
-->
<active>ALWAYS</active>
<!--
The owner of the repository.
Defaults to the same owner as the release repository.
-->
<owner>duke</owner>
<!--
The name of the repository.
Defaults to `duke-appimage`.
-->
<name>duke-appimage</name>
<!--
The tag associated with the appdata.
If left unspecified, will use `{{tagName}}`.
-->
<tagName>{{distributionName}}-{{tagName}}</tagName>
<!--
The target branch to pull from.
Defaults to the branch pointed by HEAD.
-->
<branch>HEAD</branch>
<!--
The target branch to push to.
Defaults to the branch pointed by `#{branch}`.
-->
<branchPush>{{projectName}}-{{tagName}}</branchPush>
<!--
Username used for authoring commits.
Must have write access to the repository.
Defaults to the same username as the release repository.
-->
<username>duke</username>
<!--
Password or OAuth token with write access to the repository.
-->
<token>__USE_ENVIRONMENT_VARIABLE__</token>
<!--
Message when committing to the repository.
If left unspecified, `{{distributionName}} {{tagName}}` will be used.
-->
<commitMessage>{{distributionName}} {{tagName}}</commitMessage>
</repository>
<!--
Unique identifier for this component.
See <id>
-->
<componentId>com.acme.app</componentId>
<!--
The categories this software component is associated with
See <categories>
-->
<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.
-->
<developerName>Duke</developerName>
<!--
Indicates if the executable requires access to the terminal.
Defaults to true if the distribution's stereotype is `CLI`.
-->
<requestTerminal>false</requestTerminal>
<!--
Releases to be skipped from the list of releases.
Values may be either an exact version match or a regex.
-->
<skipReleases>
<skipRelease>1.2.3</skipRelease>
<skipRelease>.*-.*</skipRelease>
</skipReleases>
<!--
A list of screenshots.
If undefined, defaults to `#{project.screenshots}`.
-->
<screenshots>
<screenshot>
<!--
Publicly available URL. PNG format is preferred.
-->
<url>https://acme.com/app.png</url>
<!--
The type of image.
Valid values are [`SOURCE`, `THUMBNAIL`].
Defaults to `SOURCE`.
-->
<type>THUMBNAIL</type>
<!--
Marks this screenshot as the primary one.
Only a single screenshot may be set as primary.
-->
<primary>true</primary>
<!--
A description of the image.
Should be no more than 100 characters long.
-->
<caption>App in action</caption>
<!--
Image width in pixels.
Required if type = `THUMBNAIL`.
-->
<width>250</width>
<!--
Image height in pixels.
Required if type = `THUMBNAIL`.
-->
<height>250</height>
<!--
Additional properties used when evaluating templates.
-->
<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}`.
-->
<icons>
<icon>
<!--
Publicly available URL. PNG format is preferred.
-->
<url>https://acme.com/app.png</url>
<!--
Marks this icon as the primary one.
Only a single icon may be set as primary.
-->
<primary>true</primary>>
<!--
Image width in pixels.
-->
<width>250</width>
<!--
Image height in pixels.
-->
<height>250</height>
<!--
Additional properties used when evaluating templates.
-->
<extraProperties>
<!--
Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
-->
<foo>bar</foo>
</extraProperties>
</icon>
</icons>
</appImage>
</packagers>
</jreleaser>
jreleaser {
//
packagers {
//
appImage {
// Enables or disables AppImage.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
//
active = 'ALWAYS'
// Let the release continue if the packager fails.
// Defaults to `false`.
//
continueOnError = true
// Custom download URL.
//
downloadUrl = 'https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}'
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `appImage`, i.e, `appImageFoo`.
//
extraProperties.put('foo', 'bar')
// Directory with file templates used to prepare the AppImage distribution.
// Defaults to `src/jreleaser/distributions/#{distribution.name}/appImage`.
// If specified, path must exist.
//
templateDirectory = 'path/to/appImage/templates'
// List of template files to be skipped.
// Value may be an exact match or a regex.
//
skipTemplate('README.md.tpl')
// Git author used to commit to the repository.
//
commitAuthor {
// Name used when authoring commits.
// Defaults to `jreleaserbot`.
//
name = 'jreleaserbot'
// E-mail used when authoring commits.
// Defaults to `jreleaser@kordamp.org`.
//
email = 'jreleaser@kordamp.org'
}
// Git repository to push the appdata to.
// Defaults are shown.
//
repository {
// Enables or disables the repository.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `RELEASE`.
//
active = 'ALWAYS'
// The owner of the repository.
// Defaults to the same owner as the release repository.
//
repoOwner = 'duke'
// The name of the repository.
// Defaults to `duke-appimage`.
//
name = 'duke-appimage'
// The tag associated with the appdata.
// If left unspecified, will use `{{tagName}}`.
//
tagName = '{{distributionName}}-{{tagName}}'
// The target branch to pull from.
// Defaults to the branch pointed by HEAD.
//
branch = 'HEAD'
// The target branch to push to.
// Defaults to the branch pointed by `#{branch}`.
//
branchPush = '{{projectName}}-{{tagName}}'
// Username used for authoring commits.
// Must have write access to the repository.
// Defaults to the same username as the release repository.
//
username = 'duke'
// Password or OAuth token with write access to the repository.
//
token = '__USE_ENVIRONMENT_VARIABLE__'
# Message when committing to the repository.
# If left unspecified, `{{distributionName}} {{tagName}}` will be used.
#
commitMessage = '{{distributionName}} {{tagName}}'
}
// Unique identifier for this component.
// See <id>
//
componentId = 'com.acme.app'
// The categories this software component is associated with
// See <categories>
//
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.
//
developerName = 'Duke'
// Indicates if the executable requires access to the terminal.
// Defaults to true if the distribution's stereotype is `CLI`.
//
requestTerminal = false
// Releases to be skipped from the list of releases.
// Values may be either an exact version match or a regex.
//
skipRelease('1.2.3')
skipRelease('.*-.*')
// A list of screenshots.
// If undefined, defaults to `#{project.screenshots}`.
//
screenshot {
// Publicly available URL. PNG format is preferred.
//
url = 'https://acme.com/app.png'
// The type of image.
// Valid values are [`SOURCE`, `THUMBNAIL`].
// Defaults to `SOURCE`.
//
screenshotType = THUMBNAIL
// Marks this screenshot as the primary one.
// Only a single screenshot may be set as primary.
//
primary = true
// A description of the image.
// Should be no more than 100 characters long.
//
caption = 'App in action'
// Image width in pixels.
// Required if type = `THUMBNAIL`.
//
width = 250
// Image height in pixels.
// Required if type = `THUMBNAIL`.
//
height = 250
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `screenshot`, i.e, `screenshot`.
//
extraProperties.put('foo', 'bar')
}
// A list of icons.
// If undefined, defaults to `#{project.icons}`.
//
icon {
// Publicly available URL. PNG format is preferred.
//
url = 'https://acme.com/app.png'
// Marks this icon as the primary one.
// Only a single icon may be set as primary.
//
primary = true
// Image width in pixels.
//
width = 250
// Image height in pixels.
//
height = 250
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `icon`, i.e, `icon`.
//
extraProperties.put('foo', 'bar')
}
}
}
}
Environment
When not explicitly set, the value of the following properties may be resolved from an environment variable or a system property as shown in the table. The system property takes precedence over the environment variable.
Inside packagers
section
System Property | Environment Variable |
---|---|
active |
|
jreleaser.packagers.appimage.active |
JRELEASER_PACKAGERS_APPIMAGE_ACTIVE |
Inside distributions
section
System Property | Environment Variable |
---|---|
active |
|
jreleaser.distributions.${name}.appimage.active |
JRELEASER_DISTRIBUTIONS_${name}_APPIMAGE_ACTIVE |
repository.active |
|
jreleaser.distributions.${name}.appimage.repository.active |
JRELEASER_DISTRIBUTIONS_${name}_APPIMAGE_REPOSITORY_ACTIVE |
repository.username |
|
jreleaser.distributions.${name}.appimage.repository.username |
JRELEASER_DISTRIBUTIONS_${name}_APPIMAGE_REPOSITORY_USERNAME |
repository.token |
|
jreleaser.distributions.${name}.appimage.repository.token |
JRELEASER_DISTRIBUTIONS_${name}_APPIMAGE_REPOSITORY_TOKEN |
repository.branch |
|
jreleaser.distributions.${name}.appimage.repository.branch |
JRELEASER_DISTRIBUTIONS_${name}_APPIMAGE_REPOSITORY_BRANCH |
repository.branchPush |
|
jreleaser.distributions.${name}.appimage.repository.branch.push |
JRELEASER_DISTRIBUTIONS_${name}_APPIMAGE_REPOSITORY_BRANCH_PUSH |
Substitute ${name} for the value of the named instance. |
Space (' '), underscore (_
), and dash (-
) will be replaced by dot (.
) to separate tokens in the System property.
Space (' '), dash (-
), and dot (.
) will be replaced by underscore (_
) to separate tokens in the environment variable,
such that:
${name} | System Property | Environment Variable |
---|---|---|
foobar |
|
|
fooBar |
|
|
foo bar |
|
|
foo-bar |
|
|
foo_bar |
|
|
foo.bar |
|
|
Tokens
The repository token environment variable must match with the chosen Release service. |
On GitHub, you can’t use the default
|
DownloadURL
JReleaser follows these rules to find the download URL to use for a given artifact:
-
if
artifact.extraProperties.appImageDownloadUrl
exists, use it. -
if
artifact.extraProperties.downloadUrl
exists, use it. -
if explicit
downloadUrl
is set onappImage
, use it. -
if
distribution.extraProperties.appImageDownloadUrl
exists, use it. -
if
distribution.extraProperties.downloadUrl
exists, use it. -
if
releaser.${release}.skipRelease
isfalse
then use the releaser’sdownloadUrl
. -
if
releaser.${release}.skipRelease
istrue
then look for a matching uploader given an extraProperty nameddownloadUrlFrom
onartifact
,distribution, `appImage
(in that order). The value must be<uploaderType>:<uploaderName>
such as "artifactory:app" or "s3:uploads". -
fail if no suitable URL is found.
With no extra configuration from your side rule 6. will be chosen which is the suitable default that most projects need.
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 Single JAR)
Any additional files found in the template directories will be copied as is unless their filename ends with .tpl
in
which case Name Templates substitution will take place.
Templates may be initialized using the template
command
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