From 7cd2911c9fb2f0414649d6dc713e63c95f34348e Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Fri, 11 Nov 2022 20:16:41 +0100 Subject: [PATCH] Document https://github.com/jreleaser/jreleaser/issues/1039 --- docs/modules/tools/pages/jreleaser-ant.adoc | 15 ++++++++++++--- docs/modules/tools/pages/jreleaser-cli.adoc | 15 ++++++++++++--- docs/modules/tools/pages/jreleaser-gradle.adoc | 17 ++++++++++++----- docs/modules/tools/pages/jreleaser-maven.adoc | 13 +++++++++++-- 4 files changed, 47 insertions(+), 13 deletions(-) diff --git a/docs/modules/tools/pages/jreleaser-ant.adoc b/docs/modules/tools/pages/jreleaser-ant.adoc index 4396eba06..8a544571f 100644 --- a/docs/modules/tools/pages/jreleaser-ant.adoc +++ b/docs/modules/tools/pages/jreleaser-ant.adoc @@ -32,12 +32,21 @@ JReleaser must be configured using the YAML, TOML, or JSON DSLs shown at xref:co The following settings may also be specified via environment variables +[options="header", cols="3*"] |=== -| Setting | Environment Variable | Default -| outputDir | JRELEASER_OUTPUT_DIRECTORY | out -| | JRELEASER_DEFAULT_GIT_REMOTE | origin +| Setting | Environment Variable | Default +| basedir | JRELEASER_BASEDIR | +| outputDir | JRELEASER_OUTPUT_DIRECTORY | out +| dryrun | JRELEASER_DRY_RUN | false +| strict | JRELEASER_STRICT | false +| gitRootSearch | JRELEASER_GIT_ROOT_SEARCH | false +| selectCurrentPlatform | JRELEASER_SELECT_CURRENT_PLATFORM | false +| selectPlatforms | JRELEASER_SELECT_PLATFORM | +| | JRELEASER_DEFAULT_GIT_REMOTE | origin |=== +`JRELEASER_SELECT_PLATFORM` may define a command separated list of values such as `osx-x86_64,linux-x86_64`. + == Tasks The following tasks are provided: diff --git a/docs/modules/tools/pages/jreleaser-cli.adoc b/docs/modules/tools/pages/jreleaser-cli.adoc index c09ba528d..25196dbe4 100644 --- a/docs/modules/tools/pages/jreleaser-cli.adoc +++ b/docs/modules/tools/pages/jreleaser-cli.adoc @@ -43,12 +43,21 @@ Documentation found at https://jreleaser.org The following settings may also be specified via environment variables +[options="header", cols="3*"] |=== -| Setting | Environment Variable | Default -| output-directory | JRELEASER_OUTPUT_DIRECTORY | out -| | JRELEASER_DEFAULT_GIT_REMOTE | origin +| Setting | Environment Variable | Default +| basedir | JRELEASER_BASEDIR | +| output-directory | JRELEASER_OUTPUT_DIRECTORY | out +| dry-run | JRELEASER_DRY_RUN | false +| strict | JRELEASER_STRICT | false +| git-root-search | JRELEASER_GIT_ROOT_SEARCH | false +| select-current-platform | JRELEASER_SELECT_CURRENT_PLATFORM | false +| select-platform | JRELEASER_SELECT_PLATFORM | +| | JRELEASER_DEFAULT_GIT_REMOTE | origin |=== +`JRELEASER_SELECT_PLATFORM` may define a command separated list of values such as `osx-x86_64,linux-x86_64`. + == Install [tabs] diff --git a/docs/modules/tools/pages/jreleaser-gradle.adoc b/docs/modules/tools/pages/jreleaser-gradle.adoc index 1e1791d68..d4744146b 100644 --- a/docs/modules/tools/pages/jreleaser-gradle.adoc +++ b/docs/modules/tools/pages/jreleaser-gradle.adoc @@ -22,14 +22,21 @@ configuration file may be used if the `configFile` field property is set in the The following properties may also be set on the `jreleaser` configuration instance: -[options="header", cols="5*"] +[options="header", cols="4*"] |=== -| Name | Type | Required | Default Value | Description -| dryrun | boolean | no | false | Skips remote operations. -| gitRootSearch | boolean | no | false | Searches for the git root -| configFile | RegularFile | no | | External configuration file +| Setting | Type | Environment Variable | Default +| basedir | boolean | JRELEASER_BASEDIR | +| dryrun | boolean | JRELEASER_DRY_RUN | false +| strict | boolean | JRELEASER_STRICT | false +| gitRootSearch | boolean | JRELEASER_GIT_ROOT_SEARCH | false +| selectCurrentPlatform | boolean | JRELEASER_SELECT_CURRENT_PLATFORM | false +| selectPlatform | String | JRELEASER_SELECT_PLATFORM | +| configFile | RegularFile | | +| | String | JRELEASER_DEFAULT_GIT_REMOTE | origin |=== +`JRELEASER_SELECT_PLATFORM` may define a command separated list of values such as `osx-x86_64,linux-x86_64`. + === Defaults The following values will be taken directly from the Gradle project and added to JReleaser's configuration when diff --git a/docs/modules/tools/pages/jreleaser-maven.adoc b/docs/modules/tools/pages/jreleaser-maven.adoc index b205e7f52..f4984b611 100644 --- a/docs/modules/tools/pages/jreleaser-maven.adoc +++ b/docs/modules/tools/pages/jreleaser-maven.adoc @@ -57,11 +57,20 @@ The value of `project.java.version` will be determined following these expressio The following settings may also be specified via environment variables +[options="header", cols="3*"] |=== -| Setting | Environment Variable | Default -| | JRELEASER_DEFAULT_GIT_REMOTE | origin +| Setting | Environment Variable | Default +| | JRELEASER_BASEDIR | +| | JRELEASER_DRY_RUN | false +| | JRELEASER_STRICT | false +| | JRELEASER_GIT_ROOT_SEARCH | false +| | JRELEASER_SELECT_CURRENT_PLATFORM | false +| | JRELEASER_SELECT_PLATFORM | +| | JRELEASER_DEFAULT_GIT_REMOTE | origin |=== +`JRELEASER_SELECT_PLATFORM` may define a command separated list of values such as `osx-x86_64,linux-x86_64`. + == Goals None of the exposed MOJOs are bound to a specific life-cycle phase, letting you decide when and how that