diff --git a/docs/modules/configuration/pages/environment.adoc b/docs/modules/configuration/pages/environment.adoc index 2802340..d97e5f5 100644 --- a/docs/modules/configuration/pages/environment.adoc +++ b/docs/modules/configuration/pages/environment.adoc @@ -115,6 +115,14 @@ jreleaser { | JRELEASER_GPG_SECRET_KEY | the secret key used for signing |=== +== Docker + +[%header, cols="<1,<1", width="100%"] +|=== +| Key | Description +| JRELEASER_DOCKER_${NAME}_PASSWORD | a docker password matching the named server +|=== + == Homebrew [%header, cols="<1,<1", width="100%"] diff --git a/docs/modules/configuration/pages/packagers/chocolatey.adoc b/docs/modules/configuration/pages/packagers/chocolatey.adoc index 03f8a08..e6ad721 100644 --- a/docs/modules/configuration/pages/packagers/chocolatey.adoc +++ b/docs/modules/configuration/pages/packagers/chocolatey.adoc @@ -84,7 +84,7 @@ packagers: # Password or OAuth token with write access to the bucket repository. # If left unspecified, the `JRELEASER_CHOCOLATEY_${GIT}_TOKEN` - # environment variable may be defined. + # environment variable must be defined. # icon:dot-circle[] icon:eye-slash[] token: __DO_NOT_SET_HERE__ ---- @@ -162,7 +162,7 @@ JSON:: // Password or OAuth token with write access to the bucket repository. // If left unspecified, the `JRELEASER_CHOCOLATEY_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] "token": "__DO_NOT_SET_HERE__" } @@ -276,7 +276,7 @@ Maven:: __DO_NOT_SET_HERE__ @@ -357,7 +357,7 @@ jreleaser { // Password or OAuth token with write access to the bucket repository. // If left unspecified, the `JRELEASER_CHOCOLATEY_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] token = '__DO_NOT_SET_HERE__' } diff --git a/docs/modules/configuration/pages/packagers/docker.adoc b/docs/modules/configuration/pages/packagers/docker.adoc index ac726db..b4bed42 100644 --- a/docs/modules/configuration/pages/packagers/docker.adoc +++ b/docs/modules/configuration/pages/packagers/docker.adoc @@ -1,11 +1,14 @@ = Docker -Creates Docker images. +Creates link:https://www.docker.com/[Docker] images. NOTE: At the moment, only artifacts with `.zip` extension may be packaged with Docker. WARNING: Snapshots are not supported. +IMPORTANT: Building and publishing docker images requires the `docker` command and a running Docker deamon. +JReleaser will not install these tools. + include::partial$legend.adoc[] [tabs] @@ -57,6 +60,37 @@ packagers: extraProperties: # Key will be capitalized and prefixed with `docker`, i.e, `dockerFoo`. foo: bar + + # A list of docker registries where images will be published. + # Image publication will be disabled if no registries are configured. + # icon:dot-circle[] + registries: + + # The name of the registry. Must be unique. + # Use `DEFAULT` to match the default registry + # provided by the Docker daemon. + # icon:exclamation-triangle[] + - serverName: myRegistry + + # The address of the docker registry. + # icon:exclamation-triangle[] if `serverName != DEFAULT`. + server: pass:[https://myregistry.com] + + # The user that can publish images. + # Defaults to the same username as the release repository. + # icon:dot-circle[] + username: duke + + # Password for login into the registry + # If left unspecified, the `JRELEASER_DOCKER_${serverName}_PASSWORD` + # environment variable must be defined. + # icon:dot-circle[] icon:eye-slash[] + password: __DO_NOT_SET_HERE__ + + # The name of the repository + # Defaults to the same owner as the release repository. + # icon:dot-circle[] + repositoryName: duke ---- JSON:: + @@ -109,7 +143,41 @@ JSON:: "extraProperties": { // Key will be capitalized and prefixed with `docker`, i.e, `dockerFoo`. "foo": "bar" - } + }, + + // A list of docker registries where images will be published. + // Image publication will be disabled if no registries are configured. + // icon:dot-circle[] + "registries": [ + + { + // The name of the registry. Must be unique. + // Use `DEFAULT` to match the default registry + // provided by the Docker daemon. + // icon:exclamation-triangle[] + "serverName": "someName", + + // The address of the docker registry. + // icon:exclamation-triangle[] if `serverName != DEFAULT`. + "server": "pass:[https://myregistry.com]", + + // The user that can publish images. + // Defaults to the same username as the release repository. + // icon:dot-circle[] + "username": "duke", + + // Password for login into the registry + // If left unspecified, the `JRELEASER_DOCKER_${serverName}_PASSWORD` + // environment variable must be defined. + // icon:dot-circle[] icon:eye-slash[] + "password": "__DO_NOT_SET_HERE__", + + // The name of the repository + // Defaults to the same owner as the release repository. + // icon:dot-circle[] + "repositoryName": "duke" + } + ] } } } @@ -186,6 +254,51 @@ Maven:: --> bar + + + + + + myRegistry + + + pass[https: myregistry.com] + + + duke + + + __DO_NOT_SET_HERE__ + + + duke + + @@ -235,6 +348,39 @@ jreleaser { // Key will be capitalized and prefixed with `scoop`, i.e, `scoopFoo`. // icon:dot-circle[] extraProperties.put('foo', 'bar') + + // A list of docker registries where images will be published. + // Image publication will be disabled if no registries are configured. + // icon:dot-circle[] + registries { + + // The name of the registry. Must be unique. + // Use `DEFAULT` to match the default registry + // provided by the Docker daemon. + // icon:exclamation-triangle[] + someName { + + // The address of the docker registry. + // icon:exclamation-triangle[] if `serverName != DEFAULT`. + server = 'pass:[https://myregistry.com]' + + // The user that can publish images. + // Defaults to the same username as the release repository. + // icon:dot-circle[] + username = 'duke' + + // Password for login into the registry + // If left unspecified, the `JRELEASER_DOCKER_${serverName}_PASSWORD` + // environment variable must be defined. + // icon:dot-circle[] icon:eye-slash[] + password = '__DO_NOT_SET_HERE__' + + // The name of the repository + // Defaults to the same owner as the release repository. + // icon:dot-circle[] + repositoryName = 'duke' + } + } } } } diff --git a/docs/modules/configuration/pages/packagers/homebrew.adoc b/docs/modules/configuration/pages/packagers/homebrew.adoc index a8f9d35..cca54e2 100644 --- a/docs/modules/configuration/pages/packagers/homebrew.adoc +++ b/docs/modules/configuration/pages/packagers/homebrew.adoc @@ -93,7 +93,7 @@ packagers: # Password or OAuth token with write access to the tap repository. # If left unspecified, the `JRELEASER_HOMEBREW_${GIT}_TOKEN` - # environment variable may be defined. + # environment variable must be defined. # icon:dot-circle[] icon:eye-slash[] token: __DO_NOT_SET_HERE__ ---- @@ -182,7 +182,7 @@ JSON:: // Password or OAuth token with write access to the tap repository. // If left unspecified, the `JRELEASER_HOMEBREW_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] "token": "__DO_NOT_SET_HERE__" } @@ -323,7 +323,7 @@ Maven:: __DO_NOT_SET_HERE__ @@ -415,7 +415,7 @@ jreleaser { // Password or OAuth token with write access to the tap repository. // If left unspecified, the `JRELEASER_HOMEBREW_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] token = '__DO_NOT_SET_HERE__' } diff --git a/docs/modules/configuration/pages/packagers/jbang.adoc b/docs/modules/configuration/pages/packagers/jbang.adoc index 76938ed..7536d93 100644 --- a/docs/modules/configuration/pages/packagers/jbang.adoc +++ b/docs/modules/configuration/pages/packagers/jbang.adoc @@ -78,7 +78,7 @@ packagers: # Password or OAuth token with write access to the catalog repository. # If left unspecified, the `JRELEASER_JBANG_${GIT}_TOKEN` - # environment variable may be defined. + # environment variable must be defined. # icon:dot-circle[] icon:eye-slash[] token: __DO_NOT_SET_HERE__ ---- @@ -151,7 +151,7 @@ JSON:: // Password or OAuth token with write access to the catalog repository. // If left unspecified, the `JRELEASER_JBANG_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] "token": "__DO_NOT_SET_HERE__" } @@ -258,7 +258,7 @@ Maven:: __DO_NOT_SET_HERE__ @@ -334,7 +334,7 @@ jreleaser { // Password or OAuth token with write access to the catalog repository. // If left unspecified, the `JRELEASER_JBANG_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] token = '__DO_NOT_SET_HERE__' } diff --git a/docs/modules/configuration/pages/packagers/scoop.adoc b/docs/modules/configuration/pages/packagers/scoop.adoc index 93df48f..fb4f5d0 100644 --- a/docs/modules/configuration/pages/packagers/scoop.adoc +++ b/docs/modules/configuration/pages/packagers/scoop.adoc @@ -83,7 +83,7 @@ packagers: # Password or OAuth token with write access to the bucket repository. # If left unspecified, the `JRELEASER_SCOOP_${GIT}_TOKEN` - # environment variable may be defined. + # environment variable must be defined. # icon:dot-circle[] icon:eye-slash[] token: __DO_NOT_SET_HERE__ ---- @@ -161,7 +161,7 @@ JSON:: // Password or OAuth token with write access to the bucket repository. // If left unspecified, the `JRELEASER_SCOOP_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] "token": "__DO_NOT_SET_HERE__" } @@ -275,7 +275,7 @@ Maven:: __DO_NOT_SET_HERE__ @@ -356,7 +356,7 @@ jreleaser { // Password or OAuth token with write access to the bucket repository. // If left unspecified, the `JRELEASER_SCOOP_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] token = '__DO_NOT_SET_HERE__' } diff --git a/docs/modules/configuration/pages/packagers/snap.adoc b/docs/modules/configuration/pages/packagers/snap.adoc index f9473e8..186e1c1 100644 --- a/docs/modules/configuration/pages/packagers/snap.adoc +++ b/docs/modules/configuration/pages/packagers/snap.adoc @@ -10,6 +10,9 @@ NOTE: At the moment, only artifacts with `.tar.gz` or `.tar` extension may be pa WARNING: Snapshots are not supported. +IMPORTANT: Building local snaps requires `snapcraft` to be pre installed. JReleaser will not install it nor its +dependencies. + include::partial$legend.adoc[] [tabs] @@ -75,7 +78,7 @@ packagers: # Password or OAuth token with write access to the snap repository. # If left unspecified, the `JRELEASER_SCNAP_${GIT}_TOKEN` - # environment variable may be defined. + # environment variable must be defined. # icon:dot-circle[] icon:eye-slash[] token: __DO_NOT_SET_HERE__ @@ -222,7 +225,7 @@ JSON:: // Password or OAuth token with write access to the snap repository. // If left unspecified, the `JRELEASER_SCNAP_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] "token": "__DO_NOT_SET_HERE__" }, @@ -413,7 +416,7 @@ Maven:: __DO_NOT_SET_HERE__ @@ -595,7 +598,7 @@ jreleaser { // Password or OAuth token with write access to the snap repository. // If left unspecified, the `JRELEASER_SCNAP_${GIT}_TOKEN` - // environment variable may be defined. + // environment variable must be defined. // icon:dot-circle[] icon:eye-slash[] token = '__DO_NOT_SET_HERE__' }