jlengrand/jreleaser.github.io
1
0
Fork 0
mirror of https://github.com/jlengrand/jreleaser.github.io.git synced 2026-03-10 08:31:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document docket image publishing

Browse Source
This commit is contained in:
Andres Almiray
2021-04-08 21:54:39 +02:00
parent 75a8640d2e
commit 56b13dc3da
7 changed files with 179 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/modules/configuration/pages/environment.adoc
View File

@@ -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%"]

8
docs/modules/configuration/pages/packagers/chocolatey.adoc
View File

@@ -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::
<!--
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__</token>
@@ -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__'
}

150
docs/modules/configuration/pages/packagers/docker.adoc
View File

@@ -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::
-->
<foo>bar</foo>
</extraProperties>
<!--
A list of docker registries where images will be published.
Image publication will be disabled if no registries are configured.
icon:dot-circle[]
-->
<registries>
<registry>
<!--
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</serverName>
<!--
The address of the docker registry.
icon:exclamation-triangle[] if `serverName != DEFAULT`.
-->
<server>pass[https: myregistry.com]</server>
<!--
The user that can publish images.
Defaults to the same username as the release repository.
icon:dot-circle[]
-->
<username>duke</username>
<!--
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__</password>
<!--
The name of the repository
Defaults to the same owner as the release repository.
icon:dot-circle[]
-->
<repositoryName>duke</repositoryName>
</registry>
</registries>
</docker>
</packagers>
</jreleaser>
@@ -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'
}
}
}
}
}

8
docs/modules/configuration/pages/packagers/homebrew.adoc
View File

@@ -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::
<!--
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__</token>
@@ -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__'
}

8
docs/modules/configuration/pages/packagers/jbang.adoc
View File

@@ -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::
<!--
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__</token>
@@ -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__'
}

8
docs/modules/configuration/pages/packagers/scoop.adoc
View File

@@ -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::
<!--
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__</token>
@@ -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__'
}

11
docs/modules/configuration/pages/packagers/snap.adoc
View File

@@ -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::
<!--
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__</token>
@@ -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__'
}