Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-07-15 01:07:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document tags format used in Gradle and Maven plugins

Browse Source 
Closes gh-33088
This commit is contained in:
Moritz Halbritter 2023-11-14 17:01:57 +01:00
parent 83da5a5bd8
commit 22a991b334
3 changed files with 41 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,6 +1,6 @@
[[spring-boot-gradle-plugin-documentation]]
= Spring Boot Gradle Plugin Reference Guide
Andy Wilkinson; Scott Frederick
Andy Wilkinson; Scott Frederick; Moritz Halbritter
v{gradle-project-version}
:!version-label:
:doctype: book

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

@ -180,7 +180,8 @@ The value supplied will be passed unvalidated to Docker when creating the builde
| `tags`
|
| A list of one or more additional tags to apply to the generated image.
The values provided to the `tags` option should be full image references in the form of `[image name]:[tag]` or `[repository]/[image name]:[tag]`.
The values provided to the `tags` option should be *full* image references.
See <<build-image.customization.tags, the tags section>> for more details.
|
| `buildCache`
@ -213,6 +214,24 @@ You can override this behaviour as shown in the <<build-image.examples.builder-c
[[build-image.customization.tags]]
=== Tags format
The values provided to the `tags` option should be *full* image references.
The accepted format is `[domainHost:port/][path/]name[:tag][@digest]`.
If the domain is missing, it defaults to `docker.io`.
If the path is missing, it defaults to `library`.
If the tag is missing, it defaults to `latest`.
Some examples:
* `my-image` leads to the image reference `docker.io/library/my-image:latest`
* `my-repository/my-image` leads to `docker.io/my-repository/my-image:latest`
* `example.com/my-repository/my-image:1.0.0` will be used as is
[[build-image.examples]]
== Examples

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

@ -189,7 +189,8 @@ The value supplied will be passed unvalidated to Docker when creating the builde
| `tags`
| One or more additional tags to apply to the generated image.
The values provided to the `tags` option should be full image references in the form of `[image name]:[tag]` or `[repository]/[image name]:[tag]`.
The values provided to the `tags` option should be *full* image references.
See <<build-image.customization.tags, the tags section>> for more details.
|
| `buildCache`
@ -221,6 +222,24 @@ You can override this behaviour as shown in the <<build-image.examples.builder-c
For more details, see also <<build-image.examples,examples>>.
[[build-image.customization.tags]]
=== Tags format
The values provided to the `tags` option should be *full* image references.
The accepted format is `[domainHost:port/][path/]name[:tag][@digest]`.
If the domain is missing, it defaults to `docker.io`.
If the path is missing, it defaults to `library`.
If the tag is missing, it defaults to `latest`.
Some examples:
* `my-image` leads to the image reference `docker.io/library/my-image:latest`
* `my-repository/my-image` leads to `docker.io/my-repository/my-image:latest`
* `example.com/my-repository/my-image:1.0.0` will be used as is
include::goals/build-image.adoc[leveloffset=+1]
include::goals/build-image-no-fork.adoc[leveloffset=+1]