Skip to content

Commit 1d0242d

Browse files
committed
readme: examples
Signed-off-by: CrazyMax <[email protected]>
1 parent d5c7867 commit 1d0242d

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

.github/workflows/reusable-distribute.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -56,68 +56,68 @@ on:
5656
required: true
5757
meta-tags:
5858
type: string
59-
description: 'List of tags as key-value pair attributes'
59+
description: "List of tags as key-value pair attributes"
6060
required: false
6161
meta-flavor:
6262
type: string
63-
description: 'Flavors to apply'
63+
description: "Flavors to apply"
6464
required: false
6565
meta-labels:
6666
type: string
67-
description: 'List of custom labels'
67+
description: "List of custom labels"
6868
required: false
6969
meta-annotations:
7070
type: string
71-
description: 'List of custom annotations'
71+
description: "List of custom annotations"
7272
required: false
7373
meta-bake-target:
7474
type: string
75-
description: 'Bake target name (default docker-metadata-action)'
75+
description: "Bake target name (default docker-metadata-action)"
7676
required: false
7777
# same as docker/login-action inputs (minus logout)
7878
login-registry:
7979
type: string
80-
description: 'Server address of Docker registry. If not set then will default to Docker Hub'
80+
description: "Server address of Docker registry. If not set then will default to Docker Hub"
8181
required: false
8282
login-username:
8383
type: string
84-
description: 'Username used to log against the Docker registry'
84+
description: "Username used to log against the Docker registry"
8585
required: false
8686
login-ecr:
8787
type: string
88-
description: 'Specifies whether the given registry is ECR (auto, true or false)'
88+
description: "Specifies whether the given registry is ECR (auto, true or false)"
8989
default: 'auto'
9090
required: false
9191
# same as docker/setup-buildx-action inputs (minus driver, install, use, endpoint, append, cleanup)
9292
buildx-version:
9393
type: string
94-
description: 'Buildx version. (eg. v0.3.0)'
94+
description: "Buildx version. (eg. v0.3.0)"
9595
required: false
9696
buildx-cache-binary:
9797
type: boolean
98-
description: 'Cache buildx binary to GitHub Actions cache backend'
98+
description: "Cache buildx binary to GitHub Actions cache backend"
9999
default: true
100100
required: false
101101
buildx-driver-opts:
102102
type: string
103-
description: 'List of additional docker-container options. (eg. image=moby/buildkit:master)'
103+
description: "List of additional docker-container options. (eg. image=moby/buildkit:master)"
104104
required: false
105105
buildkitd-flags:
106106
type: string
107-
description: 'BuildKit daemon flags'
107+
description: "BuildKit daemon flags"
108108
required: false
109109
buildkitd-config:
110110
type: string
111-
description: 'BuildKit daemon config file'
111+
description: "BuildKit daemon config file"
112112
required: false
113113
buildkitd-config-inline:
114114
type: string
115-
description: 'Inline BuildKit daemon config'
115+
description: "Inline BuildKit daemon config"
116116
required: false
117117
# same as docker/setup-qemu-action inputs (minus platforms, cache-image)
118118
qemu-image:
119119
type: string
120-
description: 'QEMU static binaries Docker image (e.g. tonistiigi/binfmt:latest)'
120+
description: "QEMU static binaries Docker image (e.g. tonistiigi/binfmt:latest)"
121121
required: false
122122
# same as docker/bake-action inputs (minus workdir, builder, targets, load, push)
123123
bake-source:
@@ -156,7 +156,7 @@ on:
156156
required: false
157157
secrets:
158158
login-username:
159-
description: 'Username used to log against the Docker registry'
159+
description: "Username used to log against the Docker registry"
160160
required: false
161161
login-password:
162162
description: "Password or personal access token used to log against the Docker registry"

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,14 @@ jobs:
143143
*.tags=user/app:latest
144144
```
145145

146+
## Examples
147+
148+
* [Distribute multi-platform build across runners](https://docs.docker.com/build/ci/github-actions/multi-platform/#distribute-build-across-multiple-runners)
149+
* [Annotations](https://docs.docker.com/build/ci/github-actions/annotations/)
150+
* [Secrets](https://docs.docker.com/build/ci/github-actions/secrets/)
151+
* [Build checks](https://docs.docker.com/build/ci/github-actions/checks/#run-checks-with-dockerbake-action)
152+
* [Reproducible builds](https://docs.docker.com/build/ci/github-actions/reproducible-builds/)
153+
146154
## Summaries
147155

148156
This action generates a [job summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/)

0 commit comments

Comments
 (0)