Asdf
asdf is a tool version manager.
The following artifact extensions are supported by this packager:
-
.tgz
-
.txz
-
.tar.gz
-
.tar.xz
-
.tar
-
.zip
Distribution Support
Distribution | Supported |
---|---|
Default templates for asdf assume the project relies on Semantic Versioning. You’ll have
to adjust the templates or provide your own if your project follows a different versioning scheme.
|
Publication of snapshots is not allowed. |
Configuration
Legend:
-
required
-
optional
-
may use environment variable
-
accepts Name Templates
#
packagers:
#
asdf:
# Enables or disables Asdf.
# 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 `asdf`, i.e, `asdfFoo`.
foo: bar
# Directory with file templates used to prepare the Asdf distribution.
# Defaults to `src/jreleaser/distributions/#{distribution.name}/asdf`.
# If specified, path must exist.
#
templateDirectory: path/to/asdf/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 plugin 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 `asdf-duke`.
#
name: asdf-duke
# The tag associated with the plugin.
# 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}}'
# Additional properties used when evaluating templates.
#
extraProperties:
# Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
foo: bar
# Tool verification command.
# Defaults to `{{distributionExecutable}} --version`.
#
toolCheck: '{{distributionExecutable}} --version'
#
[packagers.asdf]
# Enables or disables Asdf.
# 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 `asdf`, i.e, `asdfFoo`.
# Directory with file templates used to prepare the Asdf distribution.
# Defaults to `src/jreleaser/distributions/#{distribution.name}/asdf`.
# If specified, path must exist.
#
templateDirectory = "path/to/asdf/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 plugin 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 `asdf-duke`.
#
repository.name = "asdf-duke"
# The tag associated with the plugin.
# 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}}"
# Additional properties used when evaluating templates.
#
repository.extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
# Tool verification command.
# Defaults to `{{distributionExecutable}} --version`.
#
toolCheck = "{{distributionExecutable}} --version"
{
//
"packagers": {
//
"asdf": {
// Enables or disables Asdf.
// 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 `asdf`, i.e, `asdfFoo`.
"foo": "bar"
},
// Directory with file templates used to prepare the Asdf distribution.
// Defaults to `src/jreleaser/distributions/#{distribution.name}/asdf`.
// If specified, path must exist.
//
"templateDirectory": "path/to/asdf/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 plugin 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 `asdf-duke`.
//
"name": "asdf-duke",
// The tag associated with the plugin.
// 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}}",
// Additional properties used when evaluating templates.
//
"extraProperties": {
// Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
"foo": "bar"
}
},
// Tool verification command.
// Defaults to `{{distributionExecutable}} --version`.
//
"toolCheck": "{{distributionExecutable}} --version"
}
}
}
<jreleaser>
<!--
-->
<packagers>
<!--
-->
<asdf>
<!--
Enables or disables Asdf.
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 `asdf`, i.e, `asdfFoo`.
-->
<foo>bar</foo>
</extraProperties>
<!--
Directory with file templates used to prepare the Asdf distribution.
Defaults to `src/jreleaser/distributions/#{distribution.name}/asdf`.
If specified, path must exist.
-->
<templateDirectory>path/to/asdf/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 plugin 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 `asdf-duke`.
-->
<name>asdf-duke</name>
<!--
The tag associated with the plugin.
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>
<!--
Additional properties used when evaluating templates.
-->
<extraProperties>
<!--
Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
-->
<foo>bar</foo>
</extraProperties>
</repository>
<!--
Tool verification command.
Defaults to `{{distributionExecutable}} --version`.
-->
<toolCheck>{{distributionExecutable}} --version</toolCheck>
</asdf>
</packagers>
</jreleaser>
jreleaser {
//
packagers {
//
asdf {
// Enables or disables Asdf.
// 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 `asdf`, i.e, `asdfFoo`.
//
extraProperties.put('foo', 'bar')
// Directory with file templates used to prepare the Asdf distribution.
// Defaults to `src/jreleaser/distributions/#{distribution.name}/asdf`.
// If specified, path must exist.
//
templateDirectory = 'path/to/asdf/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 plugin 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 `asdf-duke`.
//
name = 'asdf-duke'
// The tag associated with the plugin.
// 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}}'
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `repository`, i.e, `repositoryFoo`.
//
extraProperties.put('foo', 'bar')
}
// Tool verification command.
// Defaults to `{{distributionExecutable}} --version`.
//
toolCheck = '{{distributionExecutable}} --version'
}
}
}
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.asdf.active |
JRELEASER_PACKAGERS_ASDF_ACTIVE |
Inside distributions
section
System Property | Environment Variable |
---|---|
active |
|
jreleaser.distributions.${name}.asdf.active |
JRELEASER_DISTRIBUTIONS_${name}_ASDF_ACTIVE |
repository.active |
|
jreleaser.distributions.${name}.asdf.repository.active |
JRELEASER_DISTRIBUTIONS_${name}_ASDF_REPOSITORY_ACTIVE |
repository.username |
|
jreleaser.distributions.${name}.asdf.repository.username |
JRELEASER_DISTRIBUTIONS_${name}_ASDF_REPOSITORY_USERNAME |
repository.token |
|
jreleaser.distributions.${name}.asdf.repository.token |
JRELEASER_DISTRIBUTIONS_${name}_ASDF_REPOSITORY_TOKEN |
repository.branch |
|
jreleaser.distributions.${name}.asdf.repository.branch |
JRELEASER_DISTRIBUTIONS_${name}_ASDF_REPOSITORY_BRANCH |
repository.branchPush |
|
jreleaser.distributions.${name}.asdf.repository.branch.push |
JRELEASER_DISTRIBUTIONS_${name}_ASDF_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.asdfDownloadUrl
exists, use it. -
if
artifact.extraProperties.downloadUrl
exists, use it. -
if explicit
downloadUrl
is set onasdf
, use it. -
if
distribution.extraProperties.asdfDownloadUrl
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, `asdf
(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.
Templates
The default location for templates is:
src/jreleaser/distributions/<distribution-name>/asdf
The following list shows the filenames that may be used to override default templates:
-
.github/workflows/build.yml.tpl
-
bin/download.tpl
-
bin/install.tpl
-
bin/list-all.tpl
-
lib/utils.bash.tpl
-
README.md.tpl
-
README-github.md.tpl
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
Skip Artifacts
If there is more than one matching artifact in a given distribution you may add a skipAsdf
extra property
to the target artifact to mark it as skipped for packaging with asdf.
Skip License
If there’s a matching LICENSE
file available at the root of the project it will be copied to the repository by default.
You may set an extra property named skipLicenseFile
on asdf to skip this behavior.
Repository
The repository
section allows setting extra properties that may be used to provide additional hints when interacting
with the git repository that holds packager files.
GitLab
Define a projectIdentifier
property to directly locate the project associated with the repository, such as
packagers:
asdf:
repository:
extraProperties:
projectIdentifier: 12345678
[packagers.asdf]
repository.extraProperties.projectIdentifier = "12345678"
{
"packagers": {
"asdf": {
"repository": {
"extraProperties": {
"projectIdentifier": "12345678"
}
}
}
}
}
<jreleaser>
<packagers>
<asdf>
<repository>
<extraProperties>
<projectIdentifier>12345678</projectIdentifier>
</extraProperties>
</repository>
</asdf>
</packagers>
</jreleaser>
jreleaser {
packagers {
asdf {
repository {
extraProperties.put("projectIdentifier", "12345678")
}
}
}
}