Executes a JReleaser workflow as Ant tasks.
Download jreleaser-ant-tasks ZIP bundle from the
releases page and unzip it in your project. Place all JARs inside
the lib
folder. Create this folder if there is none. Add the following elements to your build.xml
file
<path id="jreleaser.classpath">
<fileset dir="lib">
<include name="jreleaser-ant-tasks-{jreleaser-version}/*.jar"/>
</fileset>
</path>
<import>
<javaresource name="org/jreleaser/ant/targets.xml"
classpathref="jreleaser.classpath"/>
</import>
JReleaser must be configured using the YAML, TOML, or JSON DSLs shown at configuration:index.adoc.
The following settings may also be specified via environment variables
Setting | Environment Variable | Default |
---|---|---|
basedir |
JRELEASER_BASEDIR |
<current-execution-directory> |
outputDir |
JRELEASER_OUTPUT_DIRECTORY |
out |
dryrun |
JRELEASER_DRY_RUN |
false |
strict |
JRELEASER_STRICT |
false |
gitRootSearch |
JRELEASER_GIT_ROOT_SEARCH |
false |
selectCurrentPlatform |
JRELEASER_SELECT_CURRENT_PLATFORM |
false |
selectPlatforms |
JRELEASER_SELECT_PLATFORM |
<empty-string> |
JRELEASER_DEFAULT_GIT_REMOTE |
origin |
JRELEASER_SELECT_PLATFORM
may define a command separated list of values such as osx-x86_64,linux-x86_64
.
The following tasks are provided:
Create a jreleaser config file.
format
Type |
String |
Default value |
<none> |
Property |
jreleaser.format |
Required |
true |
Description |
Configuration file format. Currently supported formats are: |
overwrite
Type |
boolean |
Default value |
false |
Property |
jreleaser.overwrite |
Required |
false |
Description |
Overwrites existing template files. |
Display current configuration.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
full
Type |
boolean |
Default value |
false |
Property |
jreleaser.full |
Required |
false |
Description |
Display full configuration. |
announce
Type |
boolean |
Default value |
false |
Property |
jreleaser.announce |
Required |
false |
Description |
Display only announce configuration. |
assembly
Type |
boolean |
Default value |
false |
Property |
jreleaser.assembly |
Required |
false |
Description |
Display only assembly configuration. |
changelog
Type |
boolean |
Default value |
false |
Property |
jreleaser.changelog |
Required |
false |
Description |
Display only changelog configuration. |
download
Type |
boolean |
Default value |
false |
Property |
jreleaser.download |
Required |
false |
Description |
Display only download configuration. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Generate a tool/announcer template.
distributionName
Type |
String |
Default value |
<none> |
Property |
jreleaser.distribution.name |
Required |
true |
Description |
The name of the distribution. |
announcerName
Type |
String |
Default value |
<none> |
Property |
jreleaser.announcer.name |
Required |
false |
Description |
The name of the announcer to be used. |
assemblerType
Type |
String |
Default value |
<none> |
Property |
jreleaser.assembler.type |
Required |
false |
Description |
The type of the assembler to be used. |
distributionType
Type |
String |
Default value |
JAVA_BINARY |
Property |
jreleaser.distribution.type |
Required |
false |
Description |
The name of the distribution. |
packagerName
Type |
String |
Default value |
<none> |
Property |
jreleaser.packager.name |
Required |
true |
Description |
The name of the packager. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
overwrite
Type |
boolean |
Default value |
false |
Property |
jreleaser.overwrite |
Required |
false |
Description |
Overwrites existing template files. |
snapshot
Type |
boolean |
Default value |
false |
Property |
jreleaser.snapshot |
Required |
false |
Description |
Lookup snapshot specific template files. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
Downloads assets.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
downloaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of downloaders to include. |
downloaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of downloaders to include. |
dryrun
Type |
boolean |
Default value |
false |
Property |
jreleaser.dry.run |
Required |
false Description: Skips remote operations. |
excludedDownloaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of downloaders to exclude. |
excludedDownloaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of downloaders to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Assemble all distributions.
assemblers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of assemblers to run. |
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to be assembled. |
excludedAssemblers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of assemblers to exclude. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Calculate the changelog.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Calculate checksums.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Sign release artifacts.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Deploys all staged artifacts.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
deployers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to include. |
deployerNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of deployers to include. |
dryrun
Type |
boolean |
Default value |
false |
Property |
jreleaser.dry.run |
Required |
false Description: Skips remote operations. |
excludedDeployers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to exclude. |
excludedDeployerNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Uploads all artifacts.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
dryrun
Type |
boolean |
Default value |
false |
Property |
jreleaser.dry.run |
Required |
false Description: Skips remote operations. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
excludedUploaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to exclude. |
excludedUploaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
uploaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of uploaders to include. |
uploaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to include. |
Create or update a release.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
deployers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to include. |
deployerNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of deployers to include. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
excludedDeployers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to exclude. |
excludedDeployerNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to exclude. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
excludedUploaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to exclude. |
excludedUploaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to exclude. |
dryrun
Type |
boolean |
Default value |
false |
Property |
jreleaser.dry.run |
Required |
false Description: Skips remote operations. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
uploaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of uploaders to include. |
uploaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to include. |
Prepare all distributions.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
excludedPackagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of packagers to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
packagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the packagers to include. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Package all distributions.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
excludedPackagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of packagers to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
packagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the packagers to include. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Publish all distributions.
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
excludedPackagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of packagers to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
packagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the packagers to include. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Announce a release.
announcers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the announcers to include. |
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
dryrun
Type |
boolean |
Default value |
false |
Property |
jreleaser.dry.run |
Required |
false Description: Skips remote operations. |
excludedAnnouncers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of announcers to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
Perform a full release.
announcers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the announcers to include. |
deployers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to include. |
deployerNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of deployers to include. |
configFile
Type |
File |
Default value |
<none> |
Property |
jreleaser.config.file |
Required |
true |
Description |
The config file. |
distributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the distributions to include. |
dryrun
Type |
boolean |
Default value |
false |
Property |
jreleaser.dry.run |
Required |
false Description: Skips remote operations. |
excludedAnnouncers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of announcers to exclude. |
excludedDeployers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to exclude. |
excludedDeployerNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of deployers to exclude. |
excludedDistributions
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of distributions to exclude. |
excludedPackagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of packagers to exclude. |
excludedUploaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to exclude. |
excludedUploaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to exclude. |
outputDir
Type |
File |
Default value |
"build" |
Property |
jreleaser.outputdir |
Required |
false |
Description |
Overwrites existing template files. |
packagers
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Name of the packagers to include. |
selectCurrentPlatform
Type |
boolean |
Default value |
false |
Property |
jreleaser.select.current.platform |
Required |
false |
Description |
Activates paths matching the current platform. |
selectPlatforms
Type |
List<String> |
Default value |
[] |
Property
Required |
false |
Description |
Activates paths matching the given platform. |
skip
Type |
boolean |
Default value |
false |
Property |
jreleaser.skip |
Required |
false |
Description |
Skips execution of this task. |
strict
Type |
boolean |
Default value |
false |
Property |
jreleaser.strict |
Required |
false |
Description |
Enable strict mode. |
uploaderNames
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Names of uploaders to include. |
uploaderTypes
Type |
List<String> |
Default value |
<none> |
Required |
false |
Description |
Types of uploaders to include. |