Skip to content

Commit 82f0684

Browse files
committed
Merge branch '3.1.x'
Closes gh-38354
2 parents ed7cf10 + 22a991b commit 82f0684

File tree

3 files changed

+41
-3
lines changed

3 files changed

+41
-3
lines changed

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[spring-boot-gradle-plugin-documentation]]
22
= Spring Boot Gradle Plugin Reference Guide
3-
Andy Wilkinson; Scott Frederick
3+
Andy Wilkinson; Scott Frederick; Moritz Halbritter
44
v{gradle-project-version}
55
:!version-label:
66
:doctype: book

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,8 @@ The value supplied will be passed unvalidated to Docker when creating the builde
190190
| `tags`
191191
|
192192
| A list of one or more additional tags to apply to the generated image.
193-
The values provided to the `tags` option should be full image references in the form of `[image name]:[tag]` or `[repository]/[image name]:[tag]`.
193+
The values provided to the `tags` option should be *full* image references.
194+
See <<build-image.customization.tags, the tags section>> for more details.
194195
|
195196

196197
| `buildWorkspace`
@@ -236,6 +237,24 @@ You can override this behaviour as shown in the <<build-image.examples.builder-c
236237

237238

238239

240+
[[build-image.customization.tags]]
241+
=== Tags format
242+
243+
The values provided to the `tags` option should be *full* image references.
244+
The accepted format is `[domainHost:port/][path/]name[:tag][@digest]`.
245+
246+
If the domain is missing, it defaults to `docker.io`.
247+
If the path is missing, it defaults to `library`.
248+
If the tag is missing, it defaults to `latest`.
249+
250+
Some examples:
251+
252+
* `my-image` leads to the image reference `docker.io/library/my-image:latest`
253+
* `my-repository/my-image` leads to `docker.io/my-repository/my-image:latest`
254+
* `example.com/my-repository/my-image:1.0.0` will be used as is
255+
256+
257+
239258
[[build-image.examples]]
240259
== Examples
241260

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,8 @@ The value supplied will be passed unvalidated to Docker when creating the builde
199199

200200
| `tags`
201201
| One or more additional tags to apply to the generated image.
202-
The values provided to the `tags` option should be full image references in the form of `[image name]:[tag]` or `[repository]/[image name]:[tag]`.
202+
The values provided to the `tags` option should be *full* image references.
203+
See <<build-image.customization.tags, the tags section>> for more details.
203204
|
204205

205206
| `buildWorkspace`
@@ -242,6 +243,24 @@ You can override this behaviour as shown in the <<build-image.examples.builder-c
242243

243244
For more details, see also <<build-image.examples,examples>>.
244245

246+
247+
248+
[[build-image.customization.tags]]
249+
=== Tags format
250+
251+
The values provided to the `tags` option should be *full* image references.
252+
The accepted format is `[domainHost:port/][path/]name[:tag][@digest]`.
253+
254+
If the domain is missing, it defaults to `docker.io`.
255+
If the path is missing, it defaults to `library`.
256+
If the tag is missing, it defaults to `latest`.
257+
258+
Some examples:
259+
260+
* `my-image` leads to the image reference `docker.io/library/my-image:latest`
261+
* `my-repository/my-image` leads to `docker.io/my-repository/my-image:latest`
262+
* `example.com/my-repository/my-image:1.0.0` will be used as is
263+
245264
include::goals/build-image.adoc[leveloffset=+1]
246265
include::goals/build-image-no-fork.adoc[leveloffset=+1]
247266

0 commit comments

Comments
 (0)