Archive
Creates a binary distribution archive.
Configuration
Legend:
-
required
-
optional
-
may use environment variable
-
accepts Name Templates
#
assemble:
#
archive:
# Assemblers require a name.
#
app:
# Enables or disables the assembler.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
#
active: ALWAYS
# Export the assembled artifacts as a matching named distribution.
# Defaults to `true`.
#
exported: true
# The stereotype of this assembler.
# Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
# Defaults to `#{project.stereotype}`.
#
stereotype: CLI
# Additional properties used when evaluating templates.
#
extraProperties:
# Key will be capitalized and prefixed with `archive`, i.e, `archiveFoo`.
foo: bar
#
platform:
# Key value pairs.
# Keys match a full platform or an os.name, os.arch.
# Same rules apply as in Platform.
#
replacements:
osx-x86_64: mac
aarch_64: aarch64
x86_64: amd64
linux_musl: alpine
# Name of the archive.
# If left undefined, will use {{distributionName}}-{{projectVersion}}.
#
archiveName: 'app-{{projectVersion}}'
# The distribution type.
# Used to determine packager templates.
# Supported values are: [`JAVA_BINARY`, `SINGLE_JAR`, `JLINK`, `BINARY`, `NATIVE_PACKAGE`].
# Defaults to `BINARY`.
#
distributionType: JAVA_BINARY
# Attach the current platform to the archiveName.
# Defaults to `false`.
#
attachPlatform: true
# Set of archive formats to use.
# Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TAR_ZST`, `TBZ2`, `TGZ`, `TXZ`].
#
formats:
- ZIP
- TGZ
#
options:
# Timestamp to use for each entry.
# Must follow ISO-8601 +HH:MM timezone offset.
# Example: 2023-03-08T12:56:33.024578+01:00
# Defaults to timestamp for latest git commit or current time.
#
timestamp: '2020-01-01T00:00:00.000000+00:00'
# Set longFileMode for tar archives.
# Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
# Defaults to `ERROR`.
#
longFileMode: POSIX
# Set bigNumberMode for tar archives.
# Possible values are [`ERROR`, `GNU`, `POSIX`].
# Defaults to `ERROR`.
#
bigNumberMode: POSIX
# Directory with file templates used to prepare the assembler.
# Defaults to `src/jreleaser/assemblers/#{distribution.name}/archive`.
# If specified, path must exist.
#
templateDirectory: path/to/archive/templates
# List of template files to be skipped.
# Value may be an exact match or a regex.
#
skipTemplates:
- README.md.tpl
# Defines a list of additional files as artifacts.
# These files will be added to the assembled archive.
#
artifacts:
- path: path/to/file
- path: path/to/another_file
transform: path/inside/archive
- path: path/to/platform/specific/file
platform: osx-x86_64
# Defines a list of additional files as globs.
# These files will be added to the assembled archive.
#
files:
# The pattern to use.
# May use glob or regex pattern syntax.
#
- pattern: path/to/**/*.txt
#
fileSets:
# The input directory to copy files from.
#
- input: path/to/input/directory
# The target path inside the archive.
# If left undefined, defaults to the root of the archive.
#
output: path/to/archive/entry
# Fail if the given `input` does not exist.
# Defaults to `true`.
#
failOnMissingInput: false
# A set of files and directory to include.
#
includes:
- 'name_or_regex'
# A set of files and directory to exclude.
#
excludes:
- 'name_or_regex'
# Additional properties used when evaluating templates.
#
extraProperties:
# Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
foo: bar
#
swid:
# Tags require a name.
#
mytag:
# Enables or disables the tag.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
#
active: ALWAYS
# Reference to a common tag.
#
tagRef: swid-tag
# Path where the tag file will be placed.
# Defaults to `SWIDTAG`.
#
path: SWID
# A globally unique identifier and should be assigned a GUID reference.
# Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
#
tagId: c526ec37-2715-328e-8bbc-4eb5a9f47c98
# Indicates if a specific release of a software product has more than one tag that can represent that specific release.
# Defaults to `1`.
#
tagVersion: 2
# Language used in the tag document.
# Defaults to `en-US`.
#
lang: de
# If this SWID tag is a collection of information that describes the pre-installation data of software component.
# Defaults to `false`.
#
corpus: true
# If this SWID tag describes a product patch or modification to a different software element.
# Defaults to `false`.
#
patch: false
# List of organizations related to the software component referenced by this SWID tag.
#
entities:
# name of the organization claiming a particular role in the SWID tag.
#
- name: Acme
# URI of the claiming organization.
# Defaults to `http://invalid.unavailable`.
#
regid: https://acme.com
# The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
# The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
# include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
# Other roles will be defined as the market uses the SWID tags.
# Defaults to [`tagCreator`, `softwareCreator`].
#
roles:
- tagCreator
- softwareCreator# Assemblers require a name.
#
[assemble.archive.app]
# Enables or disables the assembler.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
#
active = "ALWAYS"
# Export the assembled artifacts as a matching named distribution.
# Defaults to `true`.
#
exported = true
# The stereotype of this assembler.
# Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
# Defaults to `#{project.stereotype}`.
#
stereotype = "CLI"
# Additional properties used when evaluating templates.
#
extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `archive`, i.e, `archiveFoo`.
# Key value pairs.
# Keys match a full platform or an os.name, os.arch.
# Same rules apply as in Platform.
#
[assemble.archive.app.platform.replacements]
osx-x86_64 = "mac"
aarch_64 = "aarch64"
x86_64 = "amd64"
linux_musl = "alpine"
# Name of the archive.
# If left undefined, will use {{distributionName}}-{{projectVersion}}.
#
archiveName = "app-{{projectVersion}}"
# The distribution type.
# Used to determine packager templates.
# Supported values are: [`JAVA_BINARY`, `SINGLE_JAR`, `JLINK`, `BINARY`, `NATIVE_PACKAGE`].
# Defaults to `BINARY`.
#
distributionType = "JAVA_BINARY"
# Attach the current platform to the archiveName.
#
# Defaults to `false`.
attachPlatform = true
# Set of archive formats to use.
# Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TAR_ZST`, `TBZ2`, `TGZ`, `TXZ`].
#
formats = [ "ZIP", "TGZ"]
# Timestamp to use for each entry.
# Must follow ISO-8601 +HH:MM timezone offset.
# Example: 2023-03-08T12:56:33.024578+01:00
# Defaults to timestamp for latest git commit or current time.
#
options.timestamp = "2020-01-01T00:00:00.000000+00:00"
# Set longFileMode for tar archives.
# Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
# Defaults to `ERROR`.
#
options.longFileMode = "POSIX"
# Set bigNumberMode for tar archives.
# Possible values are [`ERROR`, `GNU`, `POSIX`].
# Defaults to `ERROR`.
#
options.bigNumberMode = "POSIX"
# Directory with file templates used to prepare the assembler.
# Defaults to `src/jreleaser/assemblers/#{distribution.name}/archive`.
# If specified, path must exist.
#
templateDirectory = "path/to/archive/templates"
# List of template files to be skipped.
# Value may be an exact match or a regex.
#
skipTemplates = [ "README.md.tpl" ]
# Defines a list of additional files as artifacts.
# These files will be added to the assembled archive.
#
[[assemble.archive.app.artifacts]]
path = "path/to/file"
[[assemble.archive.app.artifacts]]
path = "path/to/another_file"
transform = "path/inside/archive"
[[assemble.archive.app.artifacts]]
path = "path/to/platform/specific/file"
platform = "osx-x86_64"
# Defines a list of additional files as globs.
# These files will be added to the assembled archive.
#
[[assemble.archive.app.files]]
# The pattern to use.
# May use glob or regex pattern syntax.
#
pattern = "path/to/**/*.txt"
#
[[assemble.archive.app.fileSets]]
# The input directory to copy files from.
#
input = "path/to/input/directory"
# The target path inside the archive.
# If left undefined, defaults to the root of the archive.
#
output = "path/to/archive/entry"
# Fail if the given `input` does not exist.
# Defaults to `true`.
#
failOnMissingInput = false
# A set of files and directory to include.
#
includes = ["name_or_regex"]
# A set of files and directory to exclude.
#
excludes = ["name_or_regex"]
# Additional properties used when evaluating templates.
#
[[assemble.archive.app.fileSets.extraProperties]]
# Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
foo: bar
#
[assemble.archive.app.swid]
# Enables or disables the tag.
# Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
#
active = "ALWAYS"
# Reference to a common tag.
#
tagRef = "swid-tag"
# Path where the tag file will be placed.
# Defaults to `SWIDTAG`.
#
path = "SWID"
# A globally unique identifier and should be assigned a GUID reference.
# Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
#
tagId = "c526ec37-2715-328e-8bbc-4eb5a9f47c98"
# Indicates if a specific release of a software product has more than one tag that can represent that specific release.
# Defaults to `1`.
#
tagVersion = 2
# Language used in the tag document.
# Defaults to `en-US`.
#
lang = "de"
# If this SWID tag is a collection of information that describes the pre-installation data of software component.
# Defaults to `false`.
#
corpus = true
# If this SWID tag describes a product patch or modification to a different software element.
# Defaults to `false`.
#
patch = false
# List of organizations related to the software component referenced by this SWID tag.
#
[[assemble.archive.app.swid.entities]]
# name of the organization claiming a particular role in the SWID tag.
#
name = "Acme"
# URI of the claiming organization.
# Defaults to `http://invalid.unavailable`.
#
regid = "https://acme.com"
# The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
# The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
# include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
# Other roles will be defined as the market uses the SWID tags.
# Defaults to [`tagCreator`, `softwareCreator`].
#
roles = ["tagCreator", "softwareCreator"]{
//
"assemble": {
//
"archive": {
// Assemblers require a name.
//
"app": {
// Enables or disables the assembler.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
//
"active": "ALWAYS",
// Export the assembled artifacts as a matching named distribution.
// Defaults to `true`.
//
"exported": true,
// The stereotype of this assembler.
// Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
// Defaults to `#{project.stereotype}`.
//
"stereotype": "CLI",
// Additional properties used when evaluating templates.
//
"extraProperties": {
// Key will be capitalized and prefixed with `archive`, i.e, `archiveFoo`.
"foo": "bar"
},
//
platform: {
// Key value pairs.
// Keys match a full platform or an os.name, os.arch.
// Same rules apply as in Platform.
//
"replacements": {
"osx-x86_64": "mac",
"aarch_64": "aarch64",
"x86_64": "amd64",
"linux_musl": "alpine"
}
},
// Name of the archive.
// If left undefined, will use {{distributionName}}-{{projectVersion}}.
//
"archiveName": "app-{{projectVersion}}",
// The distribution type.
// Used to determine packager templates.
// Supported values are: [`JAVA_BINARY`, `SINGLE_JAR`, `JLINK`, `BINARY`, `NATIVE_PACKAGE`].
// Defaults to `BINARY`.
//
"distributionType": "JAVA_BINARY",
// Attach the current platform to the archiveName.
// Defaults to `false`.
//
"attachPlatform": true,
// Set of archive formats to use.
// Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TAR_ZST`, `TBZ2`, `TGZ`, `TXZ`].
//
"formats": [
"ZIP",
"TGZ"
],
//
"options": {
// Timestamp to use for each entry.
// Must follow ISO-8601 +HH:MM timezone offset.
// Example: 2023-03-08T12:56:33.024578+01:00
// Defaults to timestamp for latest git commit or current time.
//
"timestamp": "2020-01-01T00:00:00.000000+00:00",
// Set longFileMode for tar archives.
// Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
// Defaults to `ERROR`.
//
"longFileMode": "POSIX",
// Set bigNumberMode for tar archives.
// Possible values are [`ERROR`, `GNU`, `POSIX`].
// Defaults to `ERROR`.
//
"bigNumberMode": "POSIX"
},
// Directory with file templates used to prepare the assembler.
// Defaults to `src/jreleaser/assemblers/#$#{distribution.name}/archive`.
// If specified, path must exist.
//
"templateDirectory": "path/to/archive/templates",
// List of template files to be skipped.
// Value may be an exact match or a regex.
//
"skipTemplates": [
"README.md.tpl"
],
// Defines a list of additional files as artifacts.
// These files will be added to the assembled archive.
//
"artifacts": [
{
"path": "path/to/file"
},
{
"path": "path/to/another_file",
"transform": "path/inside/archive"
},
{
"path": "path/to/platform/specific/file",
"platform": "osx-x86_64"
}
] ,
// Defines a list of additional files as globs.
// These files will be added to the assembled archive.
//
"files": [
{
// The pattern to use.
// May use glob or regex pattern syntax.
//
"pattern": "path/to/**/*.txt"
}
],
//
"fileSets": [
{
// The input directory to copy files from.
//
"input": "path/to/input/directory",
// The target path inside the archive.
// If left undefined, defaults to the root of the archive.
//
"output": "path/to/archive/entry",
// Fail if the given `input` does not exist.
// Defaults to `true`.
//
"failOnMissingInput": false,
// A set of files and directory to include.
//
"includes": ["name_or_regex"],
// A set of files and directory to exclude.
//
"excludes": ["name_or_regex"],
// Additional properties used when evaluating templates.
//
"extraProperties": {
// Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
"foo": "bar"
}
}
],
//
"swid": {
// Tags require a name.
//
"mytag": {
// Enables or disables the tag.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
//
"active": "ALWAYS",
// Reference to a common tag.
//
"tagRef": "swid-tag",
// Path where the tag file will be placed.
// Defaults to `SWIDTAG`.
//
"path": "SWID",
// A globally unique identifier and should be assigned a GUID reference.
// Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
//
"tagId": "c526ec37-2715-328e-8bbc-4eb5a9f47c98",
// Indicates if a specific release of a software product has more than one tag that can represent that specific release.
// Defaults to `1`.
//
"tagVersion": 2,
// Language used in the tag document.
// Defaults to `en-US`.
//
"lang": "de",
// If this SWID tag is a collection of information that describes the pre-installation data of software component.
// Defaults to `false`.
//
"corpus": true,
// If this SWID tag describes a product patch or modification to a different software element.
// Defaults to `false`.
//
"patch": false,
// List of organizations related to the software component referenced by this SWID tag.
//
"entities": [
{
// name of the organization claiming a particular role in the SWID tag.
//
"name": "Acme",
// URI of the claiming organization.
// Defaults to `http://invalid.unavailable`.
//
"regid": "https://acme.com",
// The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
// The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
// include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
// Other roles will be defined as the market uses the SWID tags.
// Defaults to [`tagCreator`, `softwareCreator`].
//
"roles": [
"tagCreator",
"softwareCreator"
]
}
]
}
}
}
}
}
}<jreleaser>
<!--
-->
<assemble>
<!--
-->
<archive>
<!--
Assemblers require a name.
-->
<app>
<!--
Enables or disables the distribution.
Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `ALWAYS`.
-->
<active>ALWAYS</active>
<!--
Export the assembled artifacts as a matching named distribution.
Defaults to `true`.
-->
<exported>true</exported>
<!--
The stereotype of this assembler.
Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
Defaults to `#{project.stereotype}`.
-->
<stereotype>CLI</stereotype>
<!--
Additional properties used when evaluating templates.
-->
<extraProperties>
<!--
Key will be capitalized and prefixed with `archive`, i.e, `archiveFoo`.
-->
<foo>bar</foo>
</extraProperties>
<!--
-->
<platform>
<!--
Key value pairs.
Keys match a full platform or an os.name, os.arch.
Same rules apply as in Platform.
-->
<replacements>
<osx-x86_64>mac</osx-x86_64>
<aarch_64>aarch64</aarch_64>
<x86_64>amd64</x86_64>
<linux_musl>alpine</linux_musl>
</replacements>
</platform>
<!--
Name of the archive.
If left undefined, will use {{distributionName}}-{{projectVersion}}.
-->
<archiveName>app-{{projectVersion}}</archiveName>
<!--
The distribution type.
Used to determine packager templates.
Supported values are>[`JAVA_BINARY`, `SINGLE_JAR`, `JLINK`, `BINARY`, `NATIVE_PACKAGE`].
Defaults to `BINARY`.
-->
<distributionType>JAVA_BINARY</distributionType>
<!--
Attach the current platform to the archiveName.
Defaults to `false`.
-->
<attachPlatform>true</attachPlatform>
<!--
Set of archive formats to use.
Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TAR_ZST`, `TBZ2`, `TGZ`, `TXZ`].
-->
<formats>
<format>ZIP</format>
<format>TGZ</format>
</formats>
<!--
-->
<options>
<!--
Timestamp to use for each entry.
Must follow ISO-8601 +HH:MM timezone offset.
Example: 2023-03-08T12:56:33.024578+01:00
Defaults to timestamp for latest git commit or current time.
-->
<timestamp>2020-01-01T00:00:00.000000+00:00</timestamp>
<!--
Set longFileMode for tar archives.
Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
Defaults to `ERROR`.
-->
<longFileMode>POSIX</longFileMode>
<!--
Set bigNumberMode for tar archives.
Possible values are [`ERROR`, `GNU`, `POSIX`].
Defaults to `ERROR`.
-->
<bigNumberMode>POSIX</bigNumberMode>
</options>
<!--
Directory with file templates used to prepare the assembler.
Defaults to `src/jreleaser/assemblers/#{distribution.name}/archive`.
If specified, path must exist.
-->
<templateDirectory>path/to/archive/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>
<!--
Defines a list of additional files as artifacts.
These files will be added to the assembled archive.
-->
<artifacts>
<artifact>
<path>path/to/file</path>
</artifact>
<artifact>
<path>path/to/another_file</path>
<transform>path/inside/archive</transform>
</artifact>
<artifact>
<path>path/to/platform/specific/file</path>
<platform>osx-x86_64</platform>
</artifact>
</artifacts>
<!--
Defines a list of additional files as globs.
These files will be added to the assembled archive.
-->
<files>
<file>
<!--
The pattern to use.
May use glob or regex pattern syntax.
-->
<pattern>path/to/**/*.txt</pattern>
</file>
</files>
<!--
-->
<fileSets>
<fileSet>
<!--
The input directory to copy files from.
-->
<input>path/to/input/directory</input>
<!--
The target path inside the archive.
If left undefined, defaults to the root of the archive.
-->
<output>path/to/archive/entry</output>
<!--
Fail if the given `input` does not exist.
Defaults to `true`.
-->
<failOnMissingInput>false</failOnMissingInput>
<!--
A set of files and directory to include.
-->
<includes>
<include>name_or_regex</include>
</includes>
<!--
A set of files and directory to exclude.
-->
<excludes>
<exclude>name_or_regex</exclude>
</excludes>
<!--
Additional properties used when evaluating templates.
-->
<extraProperties>
<!--
Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
-->
<foo>bar</foo>
</extraProperties>
</fileSet>
</fileSets>
<!--
-->
<swid>
<!--
Tags require a name.
-->
<mytag>
<!--
Enables or disables the tag.
Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
-->
<active>ALWAYS</active>
<!--
Reference to a common tag.
-->
<tagRef>swid-tag</tagRef>
<!--
Path where the tag file will be placed.
Defaults to `SWIDTAG`.
-->
<path>SWID</path>
<!--
A globally unique identifier and should be assigned a GUID reference.
Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
-->
<tagId>c526ec37-2715-328e-8bbc-4eb5a9f47c98</tagId>
<!--
Indicates if a specific release of a software product has more than one tag that can represent that specific release.
Defaults to `1`.
-->
<tagVersion>2</tagVersion>
<!--
Language used in the tag document.
Defaults to `en-US`.
-->
<lang>de</lang>
<!--
If this SWID tag is a collection of information that describes the pre-installation data of software component.
Defaults to `false`.
-->
<corpus>true</corpus>
<!--
If this SWID tag describes a product patch or modification to a different software element.
Defaults to `false`.
-->
<patch>false</patch>
<!--
List of organizations related to the software component referenced by this SWID tag.
-->
<entities>
<entity>
<!--
name of the organization claiming a particular role in the SWID tag.
-->
<name>Acme</name>
<!--
URI of the claiming organization.
Defaults to `http://invalid.unavailable`.
-->
<regid>https://acme.com</regid>
<!--
The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
Other roles will be defined as the market uses the SWID tags.
Defaults to [`tagCreator`, `softwareCreator`].
-->
<roles>
<role>tagCreator</role>
<role>softwareCreator</role>
</roles>
</entity>
</entities>
</swid-tag>
</swid>
</app>
</archive>
</assemble>
</jreleaser>jreleaser {
//
assemble {
//
archive {
// Assemblers require a name.
//
app {
// Enables or disables the assembler.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
//
active = 'ALWAYS'
// Export the assembled artifacts as a matching named distribution.
// Defaults to `true`.
//
exported = true
// The stereotype of this assembler.
// Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
// Defaults to `#{project.stereotype}`.
//
stereotype = 'CLI'
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `archive`, i.e, `archiveFoo`.
//
extraProperties.put('foo', 'bar')
//
platform {
// Key value pairs.
// Keys match a full platform or an os.name, os.arch.
// Same rules apply as in Platform.
//
replacements = [
'osx-x86_64': 'mac',
aarch_64: 'aarch64',
x86_64: 'amd64',
linux_musl: 'alpine'
]
}
// Name of the archive.
// If left undefined, will use {{distributionName}}-{{projectVersion}}.
//
archiveName = 'app-{{projectVersion}}'
// The distribution type.
// Used to determine packager templates.
// Supported values are = [`JAVA_BINARY`, `SINGLE_JAR`, `JLINK`, `BINARY`, `NATIVE_PACKAGE`].
// Defaults to `BINARY`.
//
distributionType = 'JAVA_BINARY'
// Attach the current platform to the archiveName.
// Defaults to `false`.
//
attachPlatform = true
// Set of archive formats to use.
// Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TAR_ZST`, `TBZ2`, `TGZ`, `TXZ`].
//
formats = [
'ZIP',
'TGZ'
]
//
options {
// Timestamp to use for each entry.
// Must follow ISO-8601 + timezone offset.
// Example: 2023-03-08T12:56:33.024578+01:00
// Defaults to timestamp for latest git commit or current time.
//
timestamp = '2020-01-01T00:00:00.000000+00:00'
// Set longFileMode for tar archives.
// Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
// Defaults to `ERROR`.
//
longFileMode = 'POSIX'
// Set bigNumberMode for tar archives.
// Possible values are [`ERROR`, `GNU`, `POSIX`].
// Defaults to `ERROR`.
//
bigNumberMode = 'POSIX'
}
// Directory with file templates used to prepare the assembler.
// Defaults to `src/jreleaser/assemblers/#{distribution.name}/archive`.
// If specified, path must exist.
//
templateDirectory = 'path/to/archive/templates'
// List of template files to be skipped.
// Value may be an exact match or a regex.
//
skipTemplate('README.md.tpl')
// Defines a list of additional files as artifacts.
// These files will be added to the assembled archive.
//
artifact {
path = 'path/to/file'
}
artifact {
path = 'path/to/another_file'
transform = 'path/inside/archive'
}
artifact {
path = 'path/to/platform/specific/file'
platform = 'osx-x86_64'
}
// Defines a list of additional files as globs.
// These files will be added to the assembled archive.
//
files {
// The pattern to use.
// May use glob or regex pattern syntax.
//
pattern = 'path/to/**/*.txt'
}
//
fileSet {
// The input directory to copy files from.
//
input = 'path/to/input/directory'
// The target path inside the archive.
// If left undefined, defaults to the root of the archive.
//
output = 'path/to/archive/entry'
// Fail if the given `input` does not exist.
// Defaults to `true`.
//
failOnMissingInput = false
// A set of files and directory to include.
//
includes = ['name_or_regex']
// A set of files and directory to exclude.
//
excludes = ['name_or_regex']
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
//
extraProperties.put('foo', 'bar')
}
//
swid {
// Tags require a name.
//
mytag {
// Enables or disables the tag.
// Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
//
active = 'ALWAYS'
// Reference to a common tag.
//
tagRef = 'swid-tag'
// Path where the tag file will be placed.
// Defaults to `SWIDTAG`.
//
path = 'SWID'
// A globally unique identifier and should be assigned a GUID reference.
// Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
//
tagId = 'c526ec37-2715-328e-8bbc-4eb5a9f47c98'
// Indicates if a specific release of a software product has more than one tag that can represent that specific release.
// Defaults to `1`.
//
tagVersion = 2
// Language used in the tag document.
// Defaults to `en-US`.
//
lang = 'de'
// If this SWID tag is a collection of information that describes the pre-installation data of software component.
// Defaults to `false`.
//
corpus = true
// If this SWID tag describes a product patch or modification to a different software element.
// Defaults to `false`.
//
patch = false
// List of organizations related to the software component referenced by this SWID tag.
//
entity {
// name of the organization claiming a particular role in the SWID tag.
//
name = 'Acme'
// URI of the claiming organization.
// Defaults to `http://invalid.unavailable`.
//
regid = 'https://acme.com'
// The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
// The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
// include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
// Other roles will be defined as the market uses the SWID tags.
// Defaults to [`tagCreator`, `softwareCreator`].
//
role('tagCreator')
role('softwareCreator')
}
}
}
}
}
}
}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.
| System Property | Environment Variable |
|---|---|
active |
|
jreleaser.assemble.archive.${name}.active |
JRELEASER_ASSEMBLE_ARCHIVE_${name}_ACTIVE |
| 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 |
|
|
Templates
The default location for templates is:
src/jreleaser/assemblers/<distribution-name>/archive
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.
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
Additional Files
There are several ways to define additional files that may be handled by this assembler.
Templates
-
You may use Name Templates inside the files to be copied.
-
They retain directory structure that is, a template found at
{templateDirectory}/foo.txt.tplwill be copied asfoo.txtwhile a template such as{templateDirectory}/docs/bar.md.tplwill be copied todocs/bar.md.
FileSets
-
May use globs or regexes to define files to be included from a starting directory.
-
They retain directory structure.
-
May rename the target parent directory.
Files
-
May use globs or regexes to define files to be included from a starting directory.
-
They do not retain directory structure. Only filenames are copied.
Artifacts
-
They do not retain directory structure by default. An artifact with
pathset tobin/launcher.shwill be copied tolauncher.sh. -
May use the
transformproperty to define the target path. An artifact withpathset tobin/launcher.shandtransformset tobin/{{projectName}}will be copied tobin/app[assumingprojectNameresolves toapp]. -
May use the
platformproperty to filter files per matching platform. An artifact withplatformset towindows-x86_64will only be copied when the matching platform is compatible withwindows-x86_64. -
Artifacts without an explicit
platformwon’t be filtered.
This assembler ignores filtering artifacts by platform when attachPlatform is not enabled.
|
Example
Given the following file structure
Unix
.
├── BUILD
├── LICENSE
├── README
└── target
└── release
└── appWindows
.
├── BUILD
├── LICENSE
├── README
└── target
└── release
└── app.exeAnd this assembly configuration
project:
version: 1.0.0
description: Sample application
authors:
- Duke
inceptionYear: 2020
assemble:
archive:
app:
active: ALWAYS
attachPlatform: true
fileSets:
- input: '.'
includes:
- 'LICENSE'
- 'README'
- input: 'target/release'
output: 'bin'
includes: [ 'app{.exe,}' ][project]
version = "1.0.0"
description = "Sample application"
authors = [ "Duke" ]
inceptionYear = "2020"
[assemble.archive.app]
active = "ALWAYS"
attachPlatform = true
[[assemble.archive.app.fileSets]]
input = "."
includes = ["LICENSE", "README"]
[[assemble.archive.app.fileSets]]
input = "target/release"
output = "bin"
includes = [ "app{.exe,}" ]{
"project": {
"version": "1.0.0",
"description": "Sample application",
"authors": [ "Duke" ],
"inceptionYear": "2020"
},
"assemble": {
"archive": {
"app": {
"active": "ALWAYS",
"attachPlatform": true,
"fileSets": [
{
"input": ".",
"includes": ["LICENSE", "README"]
},
{
"input": "target/release",
"output": "bin",
"includes": [ "app{.exe,}" ]
}
]
}
}
}
}<jreleaser>
<project>
<version>1.0.0</version>
<description>Sample application</description>
<authors>Duke</authors>
<inceptionYear>2020</inceptionYear>
</project>
<assemble>
<archive>
<app>
<active>ALWAYS</active>
<attachPlatform>true</attachPlatform>
<fileSets>
<fileSet>
<input>.</input>
<includes>
<include>LICENSE</include>
<include>README</include>
</includes>
</fileSet>
<fileSet>
<input>target/release</input>
<output>bin</output>
<includes>
<include>app{.exe,}</include>
</includes>
</fileSet>
</fileSets>
</app>
</archive>
</assemble>
</jreleaser>jreleaser {
project {
version = '1.0.0'
description = 'Sample application'
author('Duke')
inceptionYear: '2020'
}
assemble {
archive {
app {
active = 'ALWAYS'
attachPlatform = true
fileSet {
input = '.'
includes = ['LICENSE', 'README']
}
fileSet {
input = 'target/release'
output = 'bin'
includes = [ 'app{.exe,}' ]
}
}
}
}
}When run on Linux, macOs, and Windows on intel chips results in the following assembled Zip archives:
app-1.0.0-linux-x86_64.zip
app-1.0.0-linux-x86_64
├── LICENSE
├── README
└── bin
└── appapp-1.0.0-osx-x86_64.zip
app-1.0.0-osx-x86_64
├── LICENSE
├── README
└── bin
└── appapp-1.0.0-windows-x86_64.zip
app-1.0.0-wndows-x86_64
├── LICENSE
├── README
└── bin
└── app.exe