JReleaser Ant Tasks
Executes a JReleaser workflow as Ant tasks.
Install
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-1.21.0/*.jar"/>
</fileset>
</path>
<import>
<javaresource name="org/jreleaser/ant/targets.xml"
classpathref="jreleaser.classpath"/>
</import>Configuration
JReleaser must be configured using the YAML, TOML, or JSON DSLs shown at Reference.
Environment Variables
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 |
yolo |
JRELEASER_YOLO |
false |
gitRootSearch |
JRELEASER_GIT_ROOT_SEARCH |
false |
selectCurrentPlatform |
JRELEASER_SELECT_CURRENT_PLATFORM |
false |
selectPlatforms |
JRELEASER_SELECT_PLATFORMS |
<empty-string> |
rejectPlatforms |
JRELEASER_REJECT_PLATFORMS |
<empty-string> |
JRELEASER_DEFAULT_GIT_REMOTE |
origin |
JRELEASER_SELECT_PLATFORMs and JRELEASER_REJECT_PLATFORMs may define a command separated list of values such as
osx-x86_64,linux-x86_64.
These additional environment variables are supported as well:
| Environment Variable | Description |
|---|---|
NO_COLOR |
disable colors in output |
JRELEASER_NO_COLOR |
disable colors in output |
Filtering Artifacts
Many commands let you filter (include or exclude) artifacts using a combination of target properties or environment variables.
This filter capability allows you to test out a release configuration on a node where not all artifacts may be available.
For example, when building on linux-x86_64 while also having osx-x86_64 and windows-x86_64.
Use the JRELEASER_SELECT_CURRENT_PLATFORM environment variable or the selectCurrentPlatform target property.
$ JRELEASER_SELECT_CURRENT_PLATFORM ant jreleaser-checksumUse the JRELEASER_SELECT_PLATFORMS environment variable or the selectPlatform target property, i.e,
$ JRELEASER_SELECT_PLATFORMS=osx-x86_64 ant jreleaser-checksumEvery artifact whose platform property does not match the given platform will end up filtered out.
Use the JRELEASER_REJECT_PLATFORMS environment variable or the rejectPlatform target property, i.e,
$ JRELEASER_REJECT_PLATFORMS=windows-x86_64 ant jreleaser-checksumEvery artifact whose platform property matches the given platform will end up filtered out.
Tasks
The following tasks are provided:
jreleaser-env
Display environment variable names.
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
jreleaser-init
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. |
jreleaser-config
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. |
deploy
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.deploy |
| Required |
false |
| Description |
Display only deploy 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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
jreleaser-template-generate
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. |
assemblerName
| Type |
String |
| Default value |
<none> |
| Property |
jreleaser.assembler.name |
| Required |
false |
| Description |
The name of the assembler 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. |
jreleaser-template-eval
Evaluate a template or templates.
configFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.config.file |
| Required |
true |
| Description |
The config file. |
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. |
inputFile
| Type |
File |
| Property |
releaser.template.input.file |
| Required |
true |
| Description |
An input template file. |
inputDir
| Type |
File |
| Property |
releaser.template.input.dir |
| Required |
true |
| Description |
A directory with input templates. |
outputDir
| Type |
File |
| Default value |
"build" |
| Property |
jreleaser.outputdir |
| Required |
false |
| Description |
Overwrites existing template files. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
targetDir
| Type |
File |
| Property |
jreleaser.template.target.dir |
| Required |
true |
| Description |
Directory where evaluated template(s) will be placed. |
jreleaser-download
Downloads assets.
Executes the Download workflow step.
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-assemble
Assemble all distributions.
Executes the Assemble workflow step.
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-changelog
Calculate the changelog.
Executes the Changelog workflow step.
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
strict
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.strict |
| Required |
false |
| Description |
Enable strict mode. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-catalog
Catalogs all distributions and files.
Executes the Catalog workflow step.
configFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.config.file |
| Required |
true |
| Description |
The config file. |
catalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of the catalogers to include. |
distributions
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of the distributions to include. |
excludedCatalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Names of catalogers 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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-checksum
Calculate checksums.
Executes the Checksum workflow step.
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-sign
Sign release artifacts.
Executes the Sign workflow step.
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-deploy
Deploys all staged artifacts.
Executes the Deploy workflow step.
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-upload
Uploads all artifacts.
Executes the Upload workflow step.
configFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.config.file |
| Required |
true |
| Description |
The config file. |
catalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of catalogers to include. |
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. |
excludedCatalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Names of catalogers 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. |
outputDir
| Type |
File |
| Default value |
"build" |
| Property |
jreleaser.outputdir |
| Required |
false |
| Description |
Overwrites existing template files. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-release
Create or update a release.
Executes the Release workflow step.
configFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.config.file |
| Required |
true |
| Description |
The config file. |
catalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of catalogers 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. |
distributions
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of the distributions to include. |
excludedCatalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Names of catalogers 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. |
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-prepare
Prepare all distributions.
Executes the Prepare workflow step.
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-package
Package all distributions.
Executes the Package workflow step.
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-publish
Publish all distributions.
Executes the Publish workflow step.
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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-announce
Announce a release.
Executes the Announce workflow step.
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |
jreleaser-full-release
Perform a full release.
Executes the Full Release workflow step.
announcers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of the announcers to include. |
catalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Name of catalogers 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. |
excludedCatalogers
| Type |
List<String> |
| Default value |
<none> |
| Required |
false |
| Description |
Names of catalogers 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. |
rejectPlatforms
| Type |
List<String> |
| Default value |
[] |
|
Property
Required |
false |
| Description |
Activates paths not matching the given platform. |
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. |
settingsFile
| Type |
File |
| Default value |
<none> |
| Property |
jreleaser.settings.file |
| Required |
false |
| Description |
The settings file. |
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. |
yolo
| Type |
boolean |
| Default value |
false |
| Property |
jreleaser.yolo |
| Required |
false Description: Skips non-configured operations. |