From 6dd36101592bcc2dddc63b3f0c547356b861d638 Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Tue, 11 May 2021 02:27:11 +0200 Subject: [PATCH] Document Docker changes --- docs/modules/ROOT/pages/install.adoc | 7 +- .../configuration/pages/distributions.adoc | 2 +- .../configuration/pages/name-templates.adoc | 1 + .../configuration/pages/packagers/docker.adoc | 117 +++++++++++++++++- .../pages/gitlab-ci.adoc | 3 + docs/modules/examples/pages/jreleaser.adoc | 86 ++++++++----- docs/modules/tools/pages/jreleaser-cli.adoc | 66 +++++----- .../modules/tools/pages/jreleaser-docker.adoc | 44 ++++++- 8 files changed, 249 insertions(+), 77 deletions(-) diff --git a/docs/modules/ROOT/pages/install.adoc b/docs/modules/ROOT/pages/install.adoc index 5c7bb3a..77ffa3b 100644 --- a/docs/modules/ROOT/pages/install.adoc +++ b/docs/modules/ROOT/pages/install.adoc @@ -169,10 +169,13 @@ working directory at the `/workspace` volume, for example assuming the current d [source] ---- -$ docker run -it --rm -v `(pwd)`:/workspace jreleaser/jreleaser-slim: [] +$ docker run -it --rm -v `(pwd)`:/workspace \ + jreleaser/: [] ---- -NOTE: The `--basedir` argument will be automatically set to `--basedir=/workspace`. +Where image may be `jreleaser-slim`, `jreleaser-alpine`. + +NOTE: The `jreleaser` command will be automatically executed inside `/workspace`. You may also need to map environment variables to the container, such as `JRELEASER_PROJECT_VERSION`, `JRELEASER_GITHUB_TOKEN`, or others depending on your setup. Refer to the xref:configuration:index.adoc[] pages. diff --git a/docs/modules/configuration/pages/distributions.adoc b/docs/modules/configuration/pages/distributions.adoc index 27da239..1f3e0bc 100644 --- a/docs/modules/configuration/pages/distributions.adoc +++ b/docs/modules/configuration/pages/distributions.adoc @@ -421,7 +421,7 @@ jreleaser { // Used to determine packager templates. // Supported values are = [JAVA_BINARY, SINGLE_JAR, JLINK, NATIVE_IMAGE]. // icon:exclamation-triangle[] - type = 'JAVA_BINARY' + distributionType = 'JAVA_BINARY' // Name of the executable launcher. // If left undefined, will use ${distribution.name}. diff --git a/docs/modules/configuration/pages/name-templates.adoc b/docs/modules/configuration/pages/name-templates.adoc index 615a27d..c58f2ef 100644 --- a/docs/modules/configuration/pages/name-templates.adoc +++ b/docs/modules/configuration/pages/name-templates.adoc @@ -876,6 +876,7 @@ The following names are related to xref:configuration:packagers/homedocker.adoc[ | Key | Description | dockerBaseImage | the base Docker image | dockerLabels | a list of formatted labels +| dockerSpecName | tha name of the current Docker spec |=== Additionally, every key/value from `docker.extraProperties` is mapped with `docker` as key prefix and the capitalized diff --git a/docs/modules/configuration/pages/packagers/docker.adoc b/docs/modules/configuration/pages/packagers/docker.adoc index ffd224d..63365da 100644 --- a/docs/modules/configuration/pages/packagers/docker.adoc +++ b/docs/modules/configuration/pages/packagers/docker.adoc @@ -36,7 +36,7 @@ packagers: # The base Docker image to use. # icon:dot-circle[] icon:file-alt[] - baseImage: "alpine:3.13.5" + baseImage: "alpine:latest" # A list of image names. # If unspecified, a single image `{{repoOwner}}/{{distributionName}}:{{tagName}}` @@ -125,7 +125,7 @@ TOML:: # The base Docker image to use. # icon:dot-circle[] icon:file-alt[] - baseImage = "alpine:3.13.5" + baseImage = "alpine:latest" # A list of image names. # If unspecified, a single image `{{repoOwner}}/{{distributionName}}:{{tagName}}` @@ -212,7 +212,7 @@ JSON:: // The base Docker image to use. // icon:dot-circle[] icon:file-alt[] - "baseImage": "alpine:3.13.5", + "baseImage": "alpine:latest", // A list of image names. // If unspecified, a single image `{{repoOwner}}/{{distributionName}}:{{tagName}}` @@ -326,7 +326,7 @@ Maven:: The base Docker image to use. icon:dot-circle[] icon:file-alt[] --> - alpine:3.13.5 + alpine:latest