diff --git a/docs/modules/continuous-integration/pages/github-actions.adoc b/docs/modules/continuous-integration/pages/github-actions.adoc index e791685..767caf2 100644 --- a/docs/modules/continuous-integration/pages/github-actions.adoc +++ b/docs/modules/continuous-integration/pages/github-actions.adoc @@ -93,6 +93,8 @@ Should match any of the link:https://github.com/jreleaser/jreleaser/releases[pub Defaults to the directory the calling workflow runs in. |=== +Arguments may be any of those supported by the xref:tools:cli.adoc[CLI] tool. + == Environment Variables Following environment variables can be used as `step.env` keys diff --git a/docs/modules/tools/pages/ant.adoc b/docs/modules/tools/pages/ant.adoc index aa0a171..0ead296 100644 --- a/docs/modules/tools/pages/ant.adoc +++ b/docs/modules/tools/pages/ant.adoc @@ -1,3 +1,429 @@ = JReleaser Ant Tasks +Executes a JReleaser workflow as Ant tasks + +The following tasks are provided: + +== jreleaser-init + +Create a jreleaser config file. + +*format* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.format +Required:: true +Description:: Configuration file format. Currently supported formats are: `yml`, `json`. + +*overwrite* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.overwrite +Required:: false +Description:: Overwrites existing template files. + +== jreleaser-config + +Display current configuration. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-template + +Generate a tool template. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.distribution.name +Required:: true +Description:: The name of the distribution. + +--- + +*distributionType* +[horizontal] +Type:: String +Default value:: JAVA_BINARY +Property:: jreleaser.distribution.type +Required:: false +Description:: The name of the distribution. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: true +Description:: The name of the tool. + +--- + +*overwrite* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.overwrite +Required:: false +Description:: Overwrites existing template files. + +--- + +*snapshot* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.snapshot +Required:: false +Description:: Lookup snapshot specific template files. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-changelog + +Calculate the changelog. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-checksum + +Calculate checksums. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-sign + +Sign release artifacts. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-release + +Create or update a release. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-prepare + +Prepare all distributions. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: false +Description:: The name of the tool for preparing distributions. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-package + +Package all distributions. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.distribution.name +Required:: false +Description:: The name of the distribution to be packaged. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: false +Description:: The name of the tool for packaging distributions. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-upload + +Upload all distributions. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.distribution.name +Required:: false +Description:: The name of the distribution to be upload. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: false +Description:: The name of the tool for uploading distributions. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-announce + +Announce a release. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*announcerName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.announcer.name +Required:: false +Description:: The name of the announcer to be used. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + +== jreleaser-full-release + +Perform a full release. + +*configFile* +[horizontal] +Type:: File +Default value:: +Property:: jreleaser.config.file +Required:: true +Description:: The config file. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.skip +Required:: false +Description:: Skips execution of this task. + diff --git a/docs/modules/tools/pages/cli.adoc b/docs/modules/tools/pages/cli.adoc index 9c9f8d4..637cd08 100644 --- a/docs/modules/tools/pages/cli.adoc +++ b/docs/modules/tools/pages/cli.adoc @@ -1,2 +1,459 @@ = JReleaser CLI +Executes a JReleaser workflow as a command-line interface (CLI). + +[source,bash] +---- +$ jreleaser -h +Usage: jreleaser [-hV] [COMMAND] +jreleaser + -h, --help Show this help message and exit. + -V, --version Print version information and exit. +Commands: + init Create a jreleaser config file + config Display current configuration + template Generate a tool template + changelog Calculate the changelog + checksum Calculate checksums + sign Sign release artifacts + release Create or update a release + prepare Prepare all distributions + package Package all distributions + upload Upload all distributions + announce Announce a release + full-release Perform a full release +---- + +The following commands are supported: + +== init + +[source,bash] +---- +$ jreleaser init -h +Usage: jreleaser init [-dhioqVw] [-b=] [-f=] +Create a jreleaser config file + -b, --basedir= Base directory + -d, --debug Set log level to debug. + -f, --format= Configuration file format + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -o, --overwrite Overwrite existing files + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +Currently supported formats are: `yml`, `json`. + +The file will be generated at `` if specified, otherwise at the current directory. + +== config + +[source,bash] +---- +$ jreleaser config -h +Usage: jreleaser config [-dhiqVw] [-b=] [-c=] +Display current configuration + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +== template + +[source,bash] +---- +$ jreleaser template -h +Usage: jreleaser template [-dhioqsVw] [-b=] -dn= + [-dt=] -tn= +Generate a tool template + -b, --basedir= Base directory + -d, --debug Set log level to debug. + -dn, --distribution-name= + The name of the distribution + -dt, --distribution-type= + The type of the distribution + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -o, --overwrite Overwrite existing files + -q, --quiet Log errors only. + -s, --snapshot Use snapshot templates + -tn, --tool-name= + The name of the tool + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +If `--basedir` is undefined then the command assumes it's the current directory. + +The value of `--distribution-name` must eventually match the name of a configured +xref:configuration:distributions.adoc[distribution]. + +The value of `--distribution-type` must match any of the available +xref:ROOT:distributions/index.adoc[distribution types]. + +The value of `--tool-name` must match any of the available xref:configuration:packagers/index.adoc[]. + +== changelog + +[source,bash] +---- +jreleaser changelog -h +Usage: jreleaser changelog [-dhiqVw] [-b=] [-c=] +Calculate the changelog + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +== checksum + +[source,bash] +---- +jreleaser checksum -h +Usage: jreleaser checksum [-dhiqVw] [-b=] [-c=] +Calculate checksums + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +== sign + +[source,bash] +---- +jreleaser sign -h +Usage: jreleaser sign [-dhiqVw] [-b=] [-c=] +Sign release artifacts + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +== release + +[source,bash] +---- +jreleaser release -h +Usage: jreleaser release [-dhiqVwy] [-b=] [-c=] +Create or update a release + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. + -y, --dryrun Skips remote operations. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository +mutations should occur when this mode is activated. + +== prepare + +[source,bash] +---- +jreleaser prepare -h +Usage: jreleaser prepare [-dhiqVw] [-b=] [-c=] + [-dn=] [-tn=] +Prepare all distributions + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -dn, --distribution-name= + The name of the distribution + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -tn, --tool-name= + The name of the tool + -V, --version Print version information and exit. + -w, --warn Set log level to warn. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +The value of `--distribution-name` must match the name of a configured xref:configuration:distributions.adoc[distribution]. + +The value of `--tool-name` must match any of the available xref:configuration:packagers/index.adoc[]. + +You may invoke this command in the following ways: + +Prepare all distributions: +[source,bash] +---- +$ jreleaser prepare +---- + +Prepare a single distribution with all configured tools: +[source,bash] +---- +$ jreleaser prepare --distribution-name app +---- + +Prepare all distributions with a single tool: +[source,bash] +---- +$ jreleaser prepare --tool-name brew +---- + +Prepare a single distribution with a single tool: +[source,bash] +---- +$ jreleaser prepare --distribution-name app --tool-name brew +---- + +== package + +[source,bash] +---- +$ jreleaser package -h +Usage: jreleaser package [-dhiqVwy] [-b=] [-c=] + [-dn=] [-tn=] +Package all distributions + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -dn, --distribution-name= + The name of the distribution + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -tn, --tool-name= + The name of the tool + -V, --version Print version information and exit. + -w, --warn Set log level to warn. + -y, --dryrun Skips remote operations. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +The value of `--distribution-name` must match the name of a configured xref:configuration:distributions.adoc[distribution]. + +The value of `--tool-name` must match any of the available xref:configuration:packagers/index.adoc[]. + +You may invoke this command in the following ways: + +Package all distributions: +[source,bash] +---- +$ jreleaser package +---- + +Package a single distribution with all configured tools: +[source,bash] +---- +$ jreleaser package --distribution-name app +---- + +Package all distributions with a single tool: +[source,bash] +---- +$ jreleaser package --tool-name brew +---- + +Package a single distribution with a single tool: +[source,bash] +---- +$ jreleaser package --distribution-name app --tool-name brew +---- + +NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository +mutations should occur when this mode is activated. + +== upload + +[source,bash] +---- +jreleaser upload -h +Usage: jreleaser upload [-dhiqVwy] [-b=] [-c=] + [-dn=] [-tn=] +Upload all distributions + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -dn, --distribution-name= + The name of the distribution + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -tn, --tool-name= + The name of the tool + -V, --version Print version information and exit. + -w, --warn Set log level to warn. + -y, --dryrun Skips remote operations. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +The value of `--distribution-name` must match the name of a configured xref:configuration:distributions.adoc[distribution]. + +The value of `--tool-name` must match any of the available xref:configuration:packagers/index.adoc[]. + +You may invoke this command in the following ways: + +Upload all distributions: +[source,bash] +---- +$ jreleaser upload +---- + +Upload a single distribution with all configured tools: +[source,bash] +---- +$ jreleaser upload --distribution-name app +---- + +Upload all distributions with a single tool: +[source,bash] +---- +$ jreleaser upload --tool-name brew +---- + +Upload a single distribution with a single tool: +[source,bash] +---- +$ jreleaser upload --distribution-name app --tool-name brew +---- + +NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository +mutations should occur when this mode is activated. + +== announce + +[source,bash] +---- +jreleaser announce -h +Usage: jreleaser announce [-dhiqVwy] [-an=] [-b=] + [-c=] +Announce a release + -an, --announcer-name= + The name of the announcer + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. + -y, --dryrun Skips remote operations. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +The value of `--announcer-name` must match any of the available xref:configuration:announce/index.adoc[announcers]. + +You may invoke this command in the following ways: + +Announce with all configured announcers: +[source,bash] +---- +$ jreleaser announce +---- + +Announce with a single announcer: +[source,bash] +---- +$ jreleaser announce --announcer-name brew +---- + +NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository +mutations should occur when this mode is activated. + +== full-release + +[source,bash] +---- +jreleaser full-release -h +Usage: jreleaser full-release [-dhiqVwy] [-b=] [-c=] +Perform a full release + -b, --basedir= Base directory + -c, --config-file= + The config file + -d, --debug Set log level to debug. + -h, --help Show this help message and exit. + -i, --info Set log level to info. + -q, --quiet Log errors only. + -V, --version Print version information and exit. + -w, --warn Set log level to warn. + -y, --dryrun Skips remote operations. +---- + +If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|json]` and it's +found at the current directory. + +If `--basedir` is undefined then the command assumes it's the same directory that contains the resolved config file. + +NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository +mutations should occur when this mode is activated. + diff --git a/docs/modules/tools/pages/gradle.adoc b/docs/modules/tools/pages/gradle.adoc index 7c6140e..093d51f 100644 --- a/docs/modules/tools/pages/gradle.adoc +++ b/docs/modules/tools/pages/gradle.adoc @@ -1,2 +1,161 @@ = JReleaser Gradle Plugin +Executes a JReleaser workflow as a Gradle plugin. + +JReleaser must be configured using the Gradle DSL shown at xref:configuration:index.adoc[]. + +The following tasks are provided: + +== jreleaserConfig + +Display current configuration. + +== jreleaserTemplate + +Generate a tool template. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Option:: distribution-name +Required:: true +Description:: The name of the distribution. + +--- + +*distributionType* +[horizontal] +Type:: Distribution.DistributionType +Default value:: JAVA_BINARY +Option:: distribution-type +Required:: false +Description:: The name of the distribution. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Option:: tool-name +Required:: true +Description:: The name of the tool. + +--- + +*overwrite* +[horizontal] +Type:: boolean +Default value:: false +Option:: overwrite +Required:: false +Description:: Overwrites existing template files. + +--- + +*snapshot* +[horizontal] +Type:: boolean +Default value:: false +Option:: snapshot +Required:: false +Description:: Lookup snapshot specific template files. + +== jreleaserChangelog + +Calculate the changelog. + +== jreleaserChecksum + +Calculate checksums. + +== jreleaserSign + +Sign release artifacts. + +== jreleaserRelease + +Create or update a release + +== jreleaserPrepare + +Prepare all distributions. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Option:: distribution-name +Required:: false +Description:: The name of the distribution to be prepared. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Option:: tool-name +Required:: false +Description:: The name of the tool for preparing distributions. + +== jreleaserPackage + +Package all distributions. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Option:: distribution-name +Required:: false +Description:: The name of the distribution to be packaged. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Option:: tool-name +Required:: false +Description:: The name of the tool for packaging distributions. + +== jreleaserUpload + +Upload all distributions. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Option:: distribution-name +Required:: false +Description:: The name of the distribution to be upload. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Option:: tool-name +Required:: false +Description:: The name of the tool for uploading distributions. + +== jreleaserAnnounce + +Announce a release. + +*announcerName* +[horizontal] +Type:: String +Default value:: +Option:: announcer-name +Required:: false +Description:: The name of the announcer to be used. + +== jreleaserFullRelease + +Perform a full release. diff --git a/docs/modules/tools/pages/maven.adoc b/docs/modules/tools/pages/maven.adoc index d20145e..f89926d 100644 --- a/docs/modules/tools/pages/maven.adoc +++ b/docs/modules/tools/pages/maven.adoc @@ -1,2 +1,313 @@ = JReleaser Maven Plugin +Executes a JReleaser workflow as a Maven plugin. + +JReleaser must be configured using the Maven DSL shown at xref:configuration:index.adoc[]. + +None of the exposed MOJOs are bound to a specific life-cycle phase, letting you decide when and how that +should happen in your build. + +The following MOJOs are provided: + +== jreleaser:config + +Display current configuration. + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.config.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:template + +Generate a tool template. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.template.distribution.name +Required:: true +Description:: The name of the distribution. + +--- + +*distributionType* +[horizontal] +Type:: Distribution.DistributionType +Default value:: JAVA_BINARY +Property:: jreleaser.template.distribution.type +Required:: false +Description:: The name of the distribution. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.template.tool.name +Required:: true +Description:: The name of the tool. + +--- + +*overwrite* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.overwrite +Required:: false +Description:: Overwrites existing template files. + +--- + +*snapshot* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.snapshot +Required:: false +Description:: Lookup snapshot specific template files. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.template.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:changelog + +Calculate the changelog. + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.changelog.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:checksum + +Calculate checksums. + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.checksum.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:sign + +Sign release artifacts. + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.sign.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:release + +Create or update a release. + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.release.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:prepare + +Prepare all distributions. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.distribution.name +Required:: false +Description:: The name of the distribution to be prepared. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: false +Description:: The name of the tool for preparing distributions. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.prepare.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:package + +Package all distributions. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.distribution.name +Required:: false +Description:: The name of the distribution to be packaged. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: false +Description:: The name of the tool for packaging distributions. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.package.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:upload + +Upload all distributions. + +*distributionName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.distribution.name +Required:: false +Description:: The name of the distribution to be upload. + +--- + +*toolName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.tool.name +Required:: false +Description:: The name of the tool for uploading distributions. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.upload.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:announce + +Announce a release. + +*announcerName* +[horizontal] +Type:: String +Default value:: +Property:: jreleaser.announcer.name +Required:: false +Description:: The name of the announcer to be used. + +--- + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.announce.skip +Required:: false +Description:: Skips execution of this MOJO. + +== jreleaser:full-release + +Perform a full release. + +*dryrun* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.dryrun +Required:: false +Description: Skips remote operations. + +--- + +*skip* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.full.release.skip +Required:: false +Description:: Skips execution of this MOJO. + diff --git a/docs/modules/tools/pages/tool-provider.adoc b/docs/modules/tools/pages/tool-provider.adoc index ddd938d..7225968 100644 --- a/docs/modules/tools/pages/tool-provider.adoc +++ b/docs/modules/tools/pages/tool-provider.adoc @@ -1,2 +1,7 @@ = JReleaser Tool Provider +Wraps the xref:cli.adoc[] with an implementation of the +link:https://docs.oracle.com/javase/9/docs/api/java/util/spi/ToolProvider.html[java.util.spi.ToolProvider] +interface. + +Every command exposed by xref:cli.adoc[] can be invoked by this `ToolProvider`.