diff --git a/docs/modules/tools/pages/jreleaser-ant.adoc b/docs/modules/tools/pages/jreleaser-ant.adoc index 8cc489e06..4396eba06 100644 --- a/docs/modules/tools/pages/jreleaser-ant.adoc +++ b/docs/modules/tools/pages/jreleaser-ant.adoc @@ -160,6 +160,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-template Generate a tool/announcer template. @@ -330,6 +340,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-assemble Assemble all distributions. @@ -418,6 +438,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-changelog Calculate the changelog. @@ -450,6 +480,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-checksum Calculate checksums. @@ -520,6 +560,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-sign Sign release artifacts. @@ -590,6 +640,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-deploy Deploys all staged artifacts. @@ -688,6 +748,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-upload Uploads all artifacts. @@ -788,6 +858,16 @@ Description:: Skips execution of this task. --- +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + +--- + *uploaderNames* [horizontal] Type:: List @@ -940,6 +1020,16 @@ Description:: Skips execution of this task. --- +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + +--- + *uploaderNames* [horizontal] Type:: List @@ -1044,6 +1134,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-package Package all distributions. @@ -1132,6 +1232,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-publish Publish all distributions. @@ -1220,6 +1330,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-announce Announce a release. @@ -1300,6 +1420,16 @@ Property:: jreleaser.skip Required:: false Description:: Skips execution of this task. +--- + +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + === jreleaser-full-release Perform a full release. @@ -1472,6 +1602,16 @@ Description:: Skips execution of this task. --- +*strict* +[horizontal] +Type:: boolean +Default value:: false +Property:: jreleaser.strict +Required:: false +Description:: Enable strict mode. + +--- + *uploaderNames* [horizontal] Type:: List diff --git a/docs/modules/tools/pages/jreleaser-cli.adoc b/docs/modules/tools/pages/jreleaser-cli.adoc index d771027ae..c09ba528d 100644 --- a/docs/modules/tools/pages/jreleaser-cli.adoc +++ b/docs/modules/tools/pages/jreleaser-cli.adoc @@ -149,7 +149,7 @@ The file will be generated at `` if specified, otherwise at the current $ jreleaser config -h Display current configuration. -Usage: jreleaser config [-fghiqVw] [-grs] [-scp] [-b=] +Usage: jreleaser config [-fghiqVw] [-grs] [-scp] [--strict] [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [--announce | -a | --changelog | -d] @@ -179,6 +179,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -261,8 +262,8 @@ The value of `--packager` must match any of the available xref:configuration:pac $ jreleaser download -h Download assets. -Usage: jreleaser download [-ghiqVw] [--dry-run] [-grs] [-b=] - [-c=] [-od=] +Usage: jreleaser download [-ghiqVw] [--dry-run] [-grs] [--strict] + [-b=] [-c=] [-od=] [-D=]... [-P=]... [[[-d=]... [-dn=]...] | [[-xd=]... [-xdn=]...]] @@ -283,20 +284,21 @@ Options: -P, --set-property= Sets the value of a property. Repeatable. -q, --quiet Log errors only. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. Include Filter: -d, --downloader= - Include an downloader by type. Repeatable. + Include a downloader by type. Repeatable. -dn, --downloader-name= - Include an downloader by name. Repeatable. + Include a downloader by name. Repeatable. Exclude Filter: -xd, --exclude-downloader= - Exclude an downloader by type. Repeatable. + Exclude a downloader by type. Repeatable. -xdn, --exclude-downloader-name= - Exclude an downloader by name. Repeatable. + Exclude a downloader by name. Repeatable. Documentation found at https://jreleaser.org ---- @@ -321,7 +323,7 @@ This command must be invoked separately from the others. $ jreleaser assemble -h Assemble distributions. -Usage: jreleaser assemble [-ghiqVw] [-grs] [-scp] [-b=] +Usage: jreleaser assemble [-ghiqVw] [-grs] [-scp] [--strict] [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-s=]... @@ -348,6 +350,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -386,9 +389,9 @@ This command must be invoked separately from the others as some assemblers are p $ jreleaser changelog -h Calculate the changelog. -Usage: jreleaser changelog [-ghiqVw] [-grs] [-b=] [-c=] - [-od=] [-D=]... - [-P=]... +Usage: jreleaser changelog [-ghiqVw] [-grs] [--strict] [-b=] + [-c=] [-od=] + [-D=]... [-P=]... Options: -b, --basedir= Base directory. @@ -405,6 +408,7 @@ Options: -P, --set-property= Sets the value of a property. Repeatable. -q, --quiet Log errors only. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -423,7 +427,7 @@ If `--basedir` is undefined then the command assumes it's the same directory tha $ jreleaser checksum -h Calculate checksums. -Usage: jreleaser checksum [-ghiqVw] [-grs] [-scp] [-b=] +Usage: jreleaser checksum [-ghiqVw] [-grs] [-scp] [--strict] [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-d=]...] | @@ -449,6 +453,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -478,10 +483,10 @@ in the xref:configuration:distributions.adoc[distribution] section. $ jreleaser sign -h Sign release artifacts. -Usage: jreleaser sign [-ghiqVw] [-grs] [-scp] [-b=] [-c=] - [-od=] [-D=]... [-P=]... - [-sp=]... [[[-d=]...] | - [[-xd=]...]] +Usage: jreleaser sign [-ghiqVw] [-grs] [-scp] [--strict] [-b=] + [-c=] [-od=] [-D=]... + [-P=]... [-sp=]... + [[[-d=]...] | [[-xd=]...]] Options: -b, --basedir= Base directory. @@ -503,6 +508,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -532,11 +538,12 @@ in the xref:configuration:distributions.adoc[distribution] section. $ jreleaser deploy -h Deploys all staged artifacts. -Usage: jreleaser deploy [-ghiqVw] [--dry-run] [-grs] [-scp] [-b=] - [-c=] [-od=] [-D=]... - [-P=]... [-sp=]... - [[[-y=]... [-yn=]...] | - [[-xy=]... [-xyn=]...]] +Usage: jreleaser deploy [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] + [-b=] [-c=] [-od=] + [-D=]... [-P=]... + [-sp=]... [[[-y=]... + [-yn=]...] | [[-xy=]... + [-xyn=]...]] Options: -b, --basedir= Base directory. @@ -559,6 +566,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -623,12 +631,13 @@ $ jreleaser deploy --deployer artifactory --deployer-name mine $ jreleaser upload -h Upload all artifacts. -Usage: jreleaser upload [-ghiqVw] [--dry-run] [-grs] [-scp] [-b=] - [-c=] [-od=] [-D=]... - [-P=]... [-sp=]... - [[[-u=]... [-un=]... - [-d=]...] | [[-xu=]... - [-xun=]... [-xd=]...]] +Usage: jreleaser upload [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] + [-b=] [-c=] [-od=] + [-D=]... [-P=]... + [-sp=]... [[[-u=]... + [-un=]... [-d=]...] | + [[-xu=]... [-xun=]... + [-xd=]...]] Options: -b, --basedir= Base directory. @@ -651,6 +660,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -719,8 +729,8 @@ $ jreleaser upload --uploader-type artifactory --uploader-name mine $ jreleaser release -h Create or update a release. -Usage: jreleaser release [-ghiqVw] [--dry-run] [-grs] [-scp] [-b=] - [-c=] [-od=] +Usage: jreleaser release [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] + [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-d=]... [-y=]... [-yn=]... [-u=]... @@ -773,6 +783,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -891,7 +902,7 @@ mutations should occur when this mode is activated. $ jreleaser prepare -h Prepare all distributions. -Usage: jreleaser prepare [-ghiqVw] [-grs] [-scp] [-b=] +Usage: jreleaser prepare [-ghiqVw] [-grs] [-scp] [--strict] [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-d=]... @@ -918,6 +929,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -979,8 +991,8 @@ $ jreleaser prepare --distribution-name app --packager-name brew $ jreleaser package -h Package all distributions. -Usage: jreleaser package [-ghiqVw] [--dry-run] [-grs] [-scp] [-b=] - [-c=] [-od=] +Usage: jreleaser package [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] + [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-d=]... [-p=]...] | [[-xd=]... @@ -1007,6 +1019,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -1071,8 +1084,8 @@ mutations should occur when this mode is activated. $ jreleaser publish -h Publish all distributions. -Usage: jreleaser publish [-ghiqVw] [--dry-run] [-grs] [-scp] [-b=] - [-c=] [-od=] +Usage: jreleaser publish [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] + [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-d=]... [-p=]...] | [[-xd=]... @@ -1099,6 +1112,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -1163,8 +1177,8 @@ mutations should occur when this mode is activated. $ jreleaser announce -h Announce a release. -Usage: jreleaser announce [-ghiqVw] [--dry-run] [-grs] [-scp] [-b=] - [-c=] [-od=] +Usage: jreleaser announce [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] + [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... [[[-a=]...] | [[-xa=]...]] @@ -1190,6 +1204,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. @@ -1236,7 +1251,7 @@ mutations should occur when this mode is activated. $ jreleaser full-release -h Perform a full release. -Usage: jreleaser full-release [-ghiqVw] [--dry-run] [-grs] [-scp] +Usage: jreleaser full-release [-ghiqVw] [--dry-run] [-grs] [-scp] [--strict] [-b=] [-c=] [-od=] [-D=]... [-P=]... [-sp=]... @@ -1269,6 +1284,7 @@ Options: -sp, --select-platform= Activates paths matching the given platform. Repeatable. + --strict Enable strict mode. -V, --version Print version information and exit. -w, --warn Set log level to warn. diff --git a/docs/modules/tools/pages/jreleaser-gradle.adoc b/docs/modules/tools/pages/jreleaser-gradle.adoc index 8f6b81d81..1e1791d68 100644 --- a/docs/modules/tools/pages/jreleaser-gradle.adoc +++ b/docs/modules/tools/pages/jreleaser-gradle.adoc @@ -118,6 +118,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Outputs current JReleaser configuration @@ -188,6 +190,8 @@ Options --git-root-search Searches for the Git root (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Downloads assets @@ -222,6 +226,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Assemble all distributions @@ -239,6 +245,9 @@ Path Type JReleaserChangelogTask (org.jreleaser.gradle.plugin.tasks.JReleaserChangelogTask) +Options: + --strict Enable strict mode (OPTIONAL). + Description Calculate changelogs @@ -269,6 +278,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Calculate checksums @@ -299,6 +310,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Signs a release @@ -333,6 +346,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Deploys all staged artifacts @@ -367,6 +382,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + --uploader-name Include an uploader by name (OPTIONAL). --uploader Include an uploader by type (OPTIONAL). @@ -413,6 +430,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + --uploader Include an uploader by type (OPTIONAL). --uploader-name Include an uploader by name (OPTIONAL). @@ -450,6 +469,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Prepares all distributions @@ -484,6 +505,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Packages all distributions @@ -518,6 +541,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Publishes all distributions @@ -548,6 +573,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + Description Announces a release @@ -598,6 +625,8 @@ Options --select-platform Activates paths matching the given platform (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + --uploader Include an uploader by type (OPTIONAL). --uploader-name Include an uploader by name (OPTIONAL). @@ -684,6 +713,8 @@ Options --skip-tag Skip tagging the release (OPTIONAL). + --strict Enable strict mode (OPTIONAL). + --tag-name The release tga (OPTIONAL). --update Update an existing release (OPTIONAL). diff --git a/docs/modules/tools/pages/jreleaser-maven.adoc b/docs/modules/tools/pages/jreleaser-maven.adoc index f098094f7..b205e7f52 100644 --- a/docs/modules/tools/pages/jreleaser-maven.adoc +++ b/docs/modules/tools/pages/jreleaser-maven.adoc @@ -76,54 +76,59 @@ Display current configuration. Available parameters: * announce + - Display announce configuration. + - Type: boolean + - User property: `jreleaser.config.announce` + Display announce configuration. + + Type: boolean + + User property: `jreleaser.config.announce` * assembly + - Display assembly configuration. + - Type: boolean + - User property: `jreleaser.config.assembly` + Display assembly configuration. + + Type: boolean + + User property: `jreleaser.config.assembly` * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * changelog + - Display changelog configuration. + - Type: boolean + - User property: `jreleaser.config.changelog` + Display changelog configuration. + + Type: boolean + + User property: `jreleaser.config.changelog` * download + - Display download configuration. + - Type: boolean + - User property: `jreleaser.config.download` + Display download configuration. + + Type: boolean + + User property: `jreleaser.config.download` * full + - Display full configuration. + - Type: boolean + - User property: `jreleaser.config.full` + Display full configuration. + + Type: boolean + + User property: `jreleaser.config.full` * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + - Skip execution. + - Type: boolean + - User property: `jreleaser.config.skip` + Skip execution. + + Type: boolean + + User property: `jreleaser.config.skip` + + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` === jreleaser:template @@ -182,9 +187,9 @@ Downloads assets. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * dryrun + Skips remote operations. + @@ -192,29 +197,29 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDownloaderNames + - Exclude an downloader by name. + - Type: String[] + - User property: jreleaser.excluded.downloader.names + Exclude an downloader by name. + + Type: String[] + + User property: jreleaser.excluded.downloader.names * excludedDownloaders + - Exclude an downloader by type. + - Type: String[] + - User property: jreleaser.excluded.downloaders + Exclude an downloader by type. + + Type: String[] + + User property: jreleaser.excluded.downloaders * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDownloaderNames + - Include an downloader by name. + - Type: String[] + - User property: jreleaser.downloader.names + Include an downloader by name. + + Type: String[] + + User property: jreleaser.downloader.names * includedDownloaders + - Include an downloader by type. + - Type: String[] + - User property: jreleaser.downloaders + Include an downloader by type. + + Type: String[] + + User property: jreleaser.downloaders * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + @@ -225,6 +230,11 @@ Available parameters: Type: boolean + User property: `jreleaser.download.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:assemble Assemble all distributions. @@ -232,54 +242,59 @@ Assemble all distributions. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * excludedAssemblers + - Exclude an assembler. + - Type: String[] + - User property: jreleaser.excluded.assemblers + Exclude an assembler. + + Type: String[] + + User property: jreleaser.excluded.assemblers * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedAssemblers + - Include an assembler. + - Type: String[] + - User property: jreleaser.assemblers + Include an assembler. + + Type: String[] + + User property: jreleaser.assemblers * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.assemble.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:changelog Calculate the changelog. @@ -287,14 +302,14 @@ Calculate the changelog. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + @@ -305,6 +320,11 @@ Available parameters: Type: boolean + User property: `jreleaser.changelog.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:checksum Calculate checksums. @@ -312,44 +332,49 @@ Calculate checksums. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.checksum.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:sign Sign release artifacts. @@ -357,44 +382,49 @@ Sign release artifacts. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.sign.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:deploy Deploys all staged artifacts. @@ -402,9 +432,9 @@ Deploys all staged artifacts. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * dryrun + Skips remote operations. + @@ -412,49 +442,54 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDeployers + - Exclude a deployer by type. + - Type: String[] + - User property: jreleaser.excluded.deployers + Exclude a deployer by type. + + Type: String[] + + User property: jreleaser.excluded.deployers * excludedDeployerNames + - Exclude a deployer by name. + - Type: String[] + - User property: jreleaser.excluded.deployer.names + Exclude a deployer by name. + + Type: String[] + + User property: jreleaser.excluded.deployer.names * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDeployers + - Include a deployer by type. + - Type: String[] + - User property: jreleaser.deployers + Include a deployer by type. + + Type: String[] + + User property: jreleaser.deployers * includedDeployerNames + - Include a deployer by name. + - Type: String[] + - User property: jreleaser.deployer.names + Include a deployer by name. + + Type: String[] + + User property: jreleaser.deployer.names * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.deploy.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:upload Uploads all artifacts. @@ -462,9 +497,9 @@ Uploads all artifacts. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * dryrun + Skips remote operations. + @@ -472,59 +507,64 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * excludedUploaderNames + - Exclude an uploader by name. + - Type: String[] + - User property: jreleaser.excluded.uploader.names + Exclude an uploader by name. + + Type: String[] + + User property: jreleaser.excluded.uploader.names * excludedUploaders + - Exclude an uploader by type. + - Type: String[] + - User property: jreleaser.excluded.uploaders + Exclude an uploader by type. + + Type: String[] + + User property: jreleaser.excluded.uploaders * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * includedUploaderNames + - Include an uploader by name. + - Type: String[] + - User property: jreleaser.uploader.names + Include an uploader by name. + + Type: String[] + + User property: jreleaser.uploader.names * includedUploaders + - Include an uploader by type. + - Type: String[] + - User property: jreleaser.uploaders + Include an uploader by type. + + Type: String[] + + User property: jreleaser.uploaders * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.upload.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:release Create or update a release. @@ -532,9 +572,9 @@ Create or update a release. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * dryrun + Skips remote operations. + @@ -542,80 +582,85 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDeployers + - Exclude a deployer by type. + - Type: String[] + - User property: jreleaser.excluded.deployers + Exclude a deployer by type. + + Type: String[] + + User property: jreleaser.excluded.deployers * excludedDeployerNames + - Exclude a deployer by name. + - Type: String[] + - User property: jreleaser.excluded.deployer.names - User property: jreleaser.excluded.deployer.names + Exclude a deployer by name. + + Type: String[] + + User property: jreleaser.excluded.deployer.names + User property: jreleaser.excluded.deployer.names * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * excludedUploaderNames + - Exclude an uploader by name. + - Type: String[] + - User property: jreleaser.excluded.uploader.names + Exclude an uploader by name. + + Type: String[] + + User property: jreleaser.excluded.uploader.names * excludedUploaders + - Exclude an uploader by type. + - Type: String[] + - User property: jreleaser.excluded.uploaders + Exclude an uploader by type. + + Type: String[] + + User property: jreleaser.excluded.uploaders * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDeployers + - Include a deployer by type. + - Type: String[] + - User property: jreleaser.deployers + Include a deployer by type. + + Type: String[] + + User property: jreleaser.deployers * includedDeployerNames + - Include a deployer by name. + - Type: String[] + - User property: jreleaser.deployer.names + Include a deployer by name. + + Type: String[] + + User property: jreleaser.deployer.names * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * includedUploaderNames + - Include an uploader by name. + - Type: String[] + - User property: jreleaser.uploader.names + Include an uploader by name. + + Type: String[] + + User property: jreleaser.uploader.names * includedUploaders + - Include an uploader by type. + - Type: String[] + - User property: jreleaser.uploaders + Include an uploader by type. + + Type: String[] + + User property: jreleaser.uploaders * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.release.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:prepare Prepare all distributions. @@ -623,9 +668,9 @@ Prepare all distributions. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * distributionName + The name of the distribution. + @@ -638,53 +683,53 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * excludedPackagers + - Exclude a packager. + - Type: String[] + - User property: jreleaser.excluded.packagers + Exclude a packager. + + Type: String[] + + User property: jreleaser.excluded.packagers * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * includedPackagers + - Include a packager. + - Type: String[] + - User property: jreleaser.packagers + Include a packager. + + Type: String[] + + User property: jreleaser.packagers * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.prepare.skip` - * toolName + - The name of the tool. + - Type: String + - User property: `jreleaser.tool.name` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` === jreleaser:package @@ -693,9 +738,9 @@ Package all distributions. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * distributionName + The name of the distribution. + @@ -708,53 +753,53 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * excludedPackagers + - Exclude a packager. + - Type: String[] + - User property: jreleaser.excluded.packagers + Exclude a packager. + + Type: String[] + + User property: jreleaser.excluded.packagers * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * includedPackagers + - Include a packager. + - Type: String[] + - User property: jreleaser.packagers + Include a packager. + + Type: String[] + + User property: jreleaser.packagers * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.package.skip` - * toolName + - The name of the tool. + - Type: String + - User property: `jreleaser.tool.name` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` === jreleaser:publish @@ -763,9 +808,9 @@ Publish all distributions. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * distributionName + The name of the distribution. + @@ -778,53 +823,53 @@ Available parameters: User property: `jreleaser.dry.run` * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * excludedPackagers + - Exclude a packager. + - Type: String[] + - User property: jreleaser.excluded.packagers + Exclude a packager. + + Type: String[] + + User property: jreleaser.excluded.packagers * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * includedPackagers + - Include a packager. + - Type: String[] + - User property: jreleaser.packagers + Include a packager. + + Type: String[] + + User property: jreleaser.packagers * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.publish.skip` - * toolName + - The name of the tool. + - Type: String + - User property: `jreleaser.tool.name` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` === jreleaser:announce @@ -833,9 +878,9 @@ Announce a release. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * dryrun + Skips remote operations. + @@ -843,9 +888,9 @@ Available parameters: User property: `jreleaser.dry.run` * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedAnnouncers + Include an announcer. + @@ -857,20 +902,25 @@ Available parameters: User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.announce.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:full-release Perform a full release. @@ -878,9 +928,9 @@ Perform a full release. Available parameters: * configFile + - External configuration file. + - Type: File + - User property: `jreleaser.config.file` + External configuration file. + + Type: File + + User property: `jreleaser.config.file` * dryrun + Skips remote operations. + @@ -893,39 +943,39 @@ Available parameters: User property: `jreleaser.excluded.announcers` * excludedDeployers + - Exclude a deployer by type. + - Type: String[] + - User property: jreleaser.excluded.deployers + Exclude a deployer by type. + + Type: String[] + + User property: jreleaser.excluded.deployers * excludedDeployerNames + - Exclude a deployer by name. + - Type: String[] + - User property: jreleaser.excluded.deployer.names + Exclude a deployer by name. + + Type: String[] + + User property: jreleaser.excluded.deployer.names * excludedDistributions + - Exclude a distribution. + - Type: String[] + - User property: jreleaser.excluded.distributions + Exclude a distribution. + + Type: String[] + + User property: jreleaser.excluded.distributions * excludedPackagers + - Exclude a packager. + - Type: String[] + - User property: jreleaser.excluded.packagers + Exclude a packager. + + Type: String[] + + User property: jreleaser.excluded.packagers * excludedUploaderNames + - Exclude an uploader by name. + - Type: String[] + - User property: jreleaser.excluded.uploader.names + Exclude an uploader by name. + + Type: String[] + + User property: jreleaser.excluded.uploader.names * excludedUploaders + - Exclude an uploader by type. + - Type: String[] + - User property: jreleaser.excluded.uploaders + Exclude an uploader by type. + + Type: String[] + + User property: jreleaser.excluded.uploaders * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * includedAnnouncers + Include an announcer. + @@ -933,54 +983,59 @@ Available parameters: User property: `jreleaser.announcers` * includedDeployers + - Include a deployer by type. + - Type: String[] + - User property: jreleaser.deployers + Include a deployer by type. + + Type: String[] + + User property: jreleaser.deployers * includedDeployerNames + - Include a deployer by name. + - Type: String[] + - User property: jreleaser.deployer.names + Include a deployer by name. + + Type: String[] + + User property: jreleaser.deployer.names * includedDistributions + - Include a distribution. + - Type: String[] + - User property: jreleaser.distributions + Include a distribution. + + Type: String[] + + User property: jreleaser.distributions * includedPackagers + - Include a packager. + - Type: String[] + - User property: jreleaser.packagers + Include a packager. + + Type: String[] + + User property: jreleaser.packagers * includedUploaderNames + - Include an uploader by name. + - Type: String[] + - User property: jreleaser.uploader.names + Include an uploader by name. + + Type: String[] + + User property: jreleaser.uploader.names * includedUploaders + - Include an uploader by type. + - Type: String[] + - User property: jreleaser.uploaders + Include an uploader by type. + + Type: String[] + + User property: jreleaser.uploaders * outputDirectory (Default: ${project.build.directory}/jreleaser) + Type: File + User property: `jreleaser.output.directory` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * skip + Skip execution. + Type: boolean + User property: `jreleaser.full.release.skip` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + === jreleaser:auto-config-release Create or update a release with auto-config enabled. @@ -1038,9 +1093,9 @@ Available parameters: User property: `jreleaser.files` * gitRootSearch + - Searches for the Git root. + - Type: boolean + - User property: `jreleaser.git.root.search` + Searches for the Git root. + + Type: boolean + + User property: `jreleaser.git.root.search` * globs + Input file(s) to be uploaded (as globs). + @@ -1127,14 +1182,14 @@ Available parameters: User property: `jreleaser.release.name` * selectCurrentPlatform + - Activates paths matching the current platform. + - Type: boolean + - User property: jreleaser.select.current.platform + Activates paths matching the current platform. + + Type: boolean + + User property: jreleaser.select.current.platform * selectPlatforms + - Activates paths matching the given platform. + - Type: String[] + - User property: jreleaser.select.platform + Activates paths matching the given platform. + + Type: String[] + + User property: jreleaser.select.platform * signing + Sign files. + @@ -1151,6 +1206,11 @@ Available parameters: Type: boolean + User property: `jreleaser.skip.tag` + * strict + + Enable strict mode. + + Type: boolean + + User property: `jreleaser.strict` + * tagName + The release tag. + Type: String +