You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update build-push-to-dockerhub and push-to-gar-docker input definitions, and alphabetized them
* add defaults to docker build workflows
* Expand on description of docker caching
* Fix incorrect desc line break
| `repository` | String | Docker repository name (**required**) |
55
-
| `tags` | List | Tags that should be used for the image (see the [metadata-action][mda] for details) |
56
-
| `labels` | List | Labels that should be used for the image (see the [metadata-action][mda] for details) |
57
-
| `file` | String | Path and filename of the dockerfile to build from. (Default: `{context}/Dockerfile`) |
58
-
| `build-args` | String | List of arguments necessary for the Docker image to be built. |
59
-
| `target` | String | Sets the target stage to build |
60
-
| `cache-from` | String | Where cache should be fetched from ([more about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)) |
61
-
| `cache-to` | String | Where cache should be stored to ([more about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)) |
62
-
| `docker-buildx-driver` | String | The [driver](https://github.com/docker/setup-buildx-action/tree/v3/?tab=readme-ov-file#customizing) to use for Docker Buildx |
63
-
| `secrets` | List | Secrets to [expose to the build](https://github.com/docker/build-push-action). Only needed when authenticating to private repositories outside the repository in which the image is being built. |
| `build-args` | String | List of arguments necessary for the Docker image to be built. | |
52
+
| `cache-from` | String | Where cache should be fetched from ([more about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)) | type=gha |
53
+
| `cache-to` | String | Where cache should be stored to ([more about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)) | type=gha,mode=max |
54
+
| `context` | String | Path to the Docker build context. | . |
55
+
| `docker-buildx-driver` | String | The [driver](https://github.com/docker/setup-buildx-action/tree/v3/?tab=readme-ov-file#customizing) to use for Docker Buildx | docker-container |
56
+
| `file` | String | Path and filename of the dockerfile to build from. (Default: `{context}/Dockerfile`) | |
57
+
| `labels` | List | Labels that should be used for the image (see the [metadata-action][mda] for details) | |
58
+
| `load` | Boolean | Whether to load the built image into the local docker daemon. | false |
59
+
| `platforms` | String | List of platforms the image should be built for (e.g. `linux/amd64,linux/arm64`) | |
| `secrets` | String | Secrets to [expose to the build](https://github.com/docker/build-push-action). Only needed when authenticating to private repositories outside the repository in which the image is being built. | |
63
+
| `tags` | String | Tags that should be used for the image (see the [metadata-action][mda] for details) | |
64
+
| `target` | String | Sets the target stage to build | |
Copy file name to clipboardExpand all lines: actions/build-push-to-dockerhub/action.yaml
+16-12Lines changed: 16 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@ description: Build and publish docker images to DockerHub
4
4
inputs:
5
5
repository:
6
6
description: |
7
-
The caller workflow's repository
7
+
Docker repository name (**required**)
8
8
tags:
9
9
description: |
10
-
List of Docker images to be pushed.
10
+
Tags that should be used for the image (see the [metadata-action][mda] for details)
11
11
required: true
12
12
labels:
13
13
description: |
@@ -19,15 +19,15 @@ inputs:
19
19
default: "."
20
20
platforms:
21
21
description: |
22
-
List of platforms to build the image for
22
+
List of platforms the image should be built for (e.g. `linux/amd64,linux/arm64`)
23
23
required: false
24
24
push:
25
25
description: |
26
-
Also push the generated images to DockerHub
26
+
Push the generated image
27
27
default: "false"
28
28
file:
29
29
description: |
30
-
The dockerfile to use.
30
+
Path and filename of the dockerfile to build from. (Default: `{context}/Dockerfile`)
31
31
required: false
32
32
build-args:
33
33
description: |
@@ -36,26 +36,30 @@ inputs:
36
36
default: ""
37
37
target:
38
38
description: |
39
-
Target stage to build
39
+
Sets the target stage to build
40
40
required: false
41
41
cache-from:
42
42
description: |
43
-
Where cache should be fetched from
44
-
required: false
43
+
Where cache should be fetched from.
44
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
45
+
46
+
[More about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)
45
47
default: "type=gha"
46
48
cache-to:
47
49
description: |
48
-
Where cache should be stored to
49
-
required: false
50
+
Where cache should be stored to.
51
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
52
+
53
+
[More about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)
50
54
default: "type=gha,mode=max"
51
55
docker-buildx-driver:
52
56
description: |
53
-
The driver to use for Docker Buildx
57
+
The [driver](https://github.com/docker/setup-buildx-action/tree/v3/?tab=readme-ov-file#customizing) to use for Docker Buildx
54
58
required: false
55
59
default: "docker-container"
56
60
secrets:
57
61
description: |
58
-
Secrets to expose to the build. Only needed when authenticating to private repositories outside the repository in which the image is being built.
62
+
Secrets to [expose to the build](https://github.com/docker/build-push-action). Only needed when authenticating to private repositories outside the repository in which the image is being built.
Copy file name to clipboardExpand all lines: actions/docker-build-push-image/action.yaml
+24-20Lines changed: 24 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -9,39 +9,43 @@ inputs:
9
9
build-args:
10
10
description: |
11
11
List of arguments necessary for the Docker image to be built.
12
-
Passed to `docker/build-push-action`.
12
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
13
13
build-contexts:
14
14
description: |
15
15
List of additional build contexts (e.g., name=path).
16
-
Passed to `docker/build-push-action`.
16
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
17
17
buildkitd-config:
18
18
description: |
19
19
The buildkitd config file to use. Defaults to `/etc/buildkitd.toml` if you're using
20
20
Grafana's self-hosted runners.
21
-
Passed to `docker/setup-buildx-action`.
21
+
Passed to [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action?tab=readme-ov-file#inputs).
22
22
buildkitd-config-inline:
23
23
description: |
24
24
The buildkitd inline config to use.
25
-
Passed to `docker/setup-buildx-action`.
25
+
Passed to [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action?tab=readme-ov-file#inputs).
26
26
cache-from:
27
27
description: |
28
28
Where cache should be fetched from.
29
-
Passed to `docker/build-push-action`.
29
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
30
+
31
+
[More about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)
30
32
default: type=gha
31
33
cache-to:
32
34
description: |
33
35
Where cache should be stored to.
34
-
Passed to `docker/build-push-action`.
36
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
37
+
38
+
[More about GHA and container caching](https://www.kenmuse.com/blog/implementing-docker-layer-caching-in-github-actions/)
35
39
default: type=gha,mode=max
36
40
context:
37
41
description: |
38
42
Path to the Docker build context.
39
-
Passed to `docker/build-push-action`.
43
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
40
44
default: .
41
45
docker-buildx-driver:
42
46
description: |
43
47
The driver to use for Docker Buildx.
44
-
Passed to `docker/setup-buildx-action`.
48
+
Passed to [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action?tab=readme-ov-file#inputs).
45
49
default: docker-container
46
50
dockerhub-registry:
47
51
description: |
@@ -55,7 +59,7 @@ inputs:
55
59
file:
56
60
description: |
57
61
The dockerfile to use.
58
-
Passed to `docker/build-push-action`.
62
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
59
63
gar-delete-credentials-file:
60
64
description: |
61
65
Delete the Google credentials file after the action is finished.
@@ -86,46 +90,46 @@ inputs:
86
90
default: "true"
87
91
labels:
88
92
description: |
89
-
List of custom labels to add to the image as metadata (passed to `docker/build-push-action`).
90
-
Passed to `docker/build-push-action`.
93
+
List of custom labels to add to the image as metadata (Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs)).
94
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
91
95
load:
92
96
description: |
93
-
Whether to load the built image into the local docker daemon (passed to `docker/build-push-action`).
94
-
Passed to `docker/build-push-action`.
97
+
Whether to load the built image into the local docker daemon (Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs)).
98
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
95
99
default: "false"
96
100
outputs:
97
101
description: |
98
102
List of docker output destinations.
99
-
Passed to `docker/build-push-action`.
103
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
100
104
platforms:
101
105
description: |
102
106
List of platforms to build the image for.
103
-
Passed to `docker/build-push-action`.
107
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
104
108
push:
105
109
description: |
106
110
Whether to push the image to the configured registries.
107
-
Passed to `docker/build-push-action`.
111
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
108
112
registries:
109
113
description: |
110
114
CSV list of registries to build images for.
111
115
Accepted registries are "gar" and "dockerhub".
112
116
secrets:
113
117
description: |
114
118
Secrets to expose to the build. Only needed when authenticating to private repositories outside the repository in which the image is being built.
115
-
Passed to `docker/build-push-action`.
119
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
116
120
ssh:
117
121
description: |
118
122
List of SSH agent socket or keys to expose to the build
119
-
Passed to `docker/build-push-action`.
123
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
120
124
tags:
121
125
description: |
122
126
List of Docker tags to be pushed.
123
-
Passed to `docker/build-push-action`.
127
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
124
128
required: true
125
129
target:
126
130
description: |
127
131
Sets the target stage to build.
128
-
Passed to `docker/build-push-action`.
132
+
Passed to [docker/build-push-action](https://github.com/docker/build-push-action?tab=readme-ov-file#inputs).
0 commit comments