Merge pull request #1548 from crazy-max/docs-link-secret-inputs
Some checks failed
codeql / analyze (push) Failing after 1m9s
validate / prepare (push) Successful in 22s
zizmor / zizmor (push) Failing after 1s
test / test (push) Successful in 48s
validate / validate (push) Successful in 1m19s
e2e / build (aws, AWS ECR Public, public.ecr.aws, public.ecr.aws/q3b5f1u4/test-docker-action, remote) (push) Failing after 3m9s
e2e / build (ghcr, GitHub, ghcr.io, ghcr.io/docker-ghactiontest/test, remote) (push) Failing after 3m6s
e2e / build (gitlab, GitLab, registry.gitlab.com, registry.gitlab.com/test1716/test, remote) (push) Failing after 3m25s
e2e / build (aws, AWS ECR, 175142243308.dkr.ecr.us-east-2.amazonaws.com, 175142243308.dkr.ecr.us-east-2.amazonaws.com/sandbox/test-docker-action, remote) (push) Failing after 3m30s
e2e / build (artifactory, Artifactory, infradock.jfrog.io, infradock.jfrog.io/test-ghaction/build-push-action, remote) (push) Failing after 3m43s
e2e / build (gar, Google Artifact Registry, us-east4-docker.pkg.dev, us-east4-docker.pkg.dev/sandbox-298914/docker-official-github-actions/test-docker-action, remote) (push) Failing after 3m41s
e2e / build (none, distribution, Distribution, local) (push) Failing after 39s
e2e / build (none, harbor, Harbor, local) (push) Failing after 41s
ci / git-context-secret (push) Failing after 9s
e2e / build (acr, Azure Container Registry, officialgithubactions.azurecr.io, officialgithubactions.azurecr.io/test-docker-action, remote) (push) Failing after 4m3s
e2e / build (dockerhub, Docker Hub, , ghactionstest/ghactionstest, remote) (push) Failing after 4m1s
e2e / build (none, nexus, Nexus, local) (push) Failing after 43s
ci / path-context (push) Failing after 8s
ci / error (push) Failing after 22s
ci / docker-driver (push) Failing after 10s
ci / export-docker (push) Successful in 24s
ci / example (push) Failing after 1m0s
e2e / build (quay, Quay, quay.io, quay.io/docker_build_team/ghactiontest, remote) (push) Failing after 1m23s
ci / error-buildx (push) Successful in 1m0s
ci / secret (push) Successful in 45s
ci / secret-files (push) Successful in 33s
ci / secret-envs (push) Successful in 40s
ci / network (push) Successful in 42s
ci / ulimit (push) Successful in 38s
ci / shm-size (push) Successful in 40s
ci / cgroup-parent (push) Successful in 33s
ci / add-hosts (push) Successful in 38s
ci / attests-compat (moby/buildkit:buildx-stable-1, v0.9.1) (push) Failing after 26s
ci / no-cache-filters (push) Successful in 41s
ci / provenance (, type=image,name=localhost:5000/name/app:latest,push=true, image) (push) Failing after 11s
ci / provenance (mode=max, /tmp/buildx-build, binary) (push) Failing after 10s
ci / provenance (mode=max, type=image,name=localhost:5000/name/app:latest,push=true, image) (push) Failing after 12s
ci / attests-compat (moby/buildkit:latest, edge) (push) Successful in 1m17s
ci / sbom (/tmp/buildx-build, binary) (push) Failing after 9s
ci / sbom (type=image,name=localhost:5000/name/app:latest,push=true, image) (push) Failing after 8s
ci / multi (multi) (push) Failing after 10s
ci / attests-compat (moby/buildkit:buildx-stable-1, latest) (push) Successful in 1m39s
ci / multi (multi-sudo) (push) Failing after 8s
ci / digest (docker, false, false) (push) Failing after 10s
ci / digest (docker, false, true) (push) Failing after 9s
ci / digest (docker-container, false, false) (push) Failing after 10s
ci / digest (docker-container, false, true) (push) Failing after 8s
ci / attests-compat (moby/buildkit:v0.10.6, latest) (push) Successful in 1m41s
ci / registry-cache (push) Failing after 7s
ci / provenance (, /tmp/buildx-build, binary) (push) Failing after 1m39s
ci / local-cache (push) Failing after 7s
ci / github-cache (push) Failing after 10s
ci / digest (docker, true, false) (push) Successful in 39s
ci / named-context-pin (push) Successful in 35s
ci / named-context-docker (push) Successful in 33s
ci / minimal (push) Successful in 5m4s
ci / digest (docker-container, true, false) (push) Successful in 56s
ci / standalone (push) Successful in 43s
ci / git-context-query (push) Failing after 5m7s
ci / proxy-docker-config (push) Failing after 12s
ci / multi-output (push) Failing after 9s
ci / git-context (push) Failing after 5m15s
ci / named-context-container (push) Successful in 45s
ci / docker-config-malformed (push) Successful in 17s
ci / proxy-buildkitd (push) Failing after 13s
ci / summary-not-supported (push) Failing after 20s
ci / annotations (push) Failing after 56s
ci / checks (edge) (push) Successful in 40s
ci / load-and-push (push) Failing after 1m2s
ci / checks (latest) (push) Successful in 53s
ci / checks (v0.14.1) (push) Successful in 35s
ci / annotations-disabled (push) Successful in 42s
ci / call-check (push) Successful in 36s
ci / summary-disable (push) Successful in 6m39s
ci / record-upload-disable (push) Successful in 6m42s
ci / record-retention-days (0) (push) Successful in 7m10s
ci / record-retention-days (2) (push) Successful in 7m11s
ci / no-default-attestations (push) Successful in 6m41s

readme: link secret inputs to the GitHub Actions secrets guide
This commit is contained in:
Tõnis Tiigi
2026-05-28 17:30:01 -07:00
committed by GitHub

View File

@@ -249,9 +249,9 @@ The following inputs can be used as `step.with` keys:
| `pull` | Bool | Always attempt to pull all referenced images (default `false`) | | `pull` | Bool | Always attempt to pull all referenced images (default `false`) |
| `push` | Bool | [Push](https://docs.docker.com/engine/reference/commandline/buildx_build/#push) is a shorthand for `--output=type=registry` (default `false`) | | `push` | Bool | [Push](https://docs.docker.com/engine/reference/commandline/buildx_build/#push) is a shorthand for `--output=type=registry` (default `false`) |
| `sbom` | Bool/String | Generate [SBOM](https://docs.docker.com/build/attestations/sbom/) attestation for the build (shorthand for `--attest=type=sbom`) | | `sbom` | Bool/String | Generate [SBOM](https://docs.docker.com/build/attestations/sbom/) attestation for the build (shorthand for `--attest=type=sbom`) |
| `secrets` | List | List of [secrets](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret) to expose to the build (e.g., `key=string`, `GIT_AUTH_TOKEN=mytoken`) | | `secrets` | List | List of [secrets](https://docs.docker.com/build/ci/github-actions/secrets/) to expose to the build (e.g., `key=string`, `GIT_AUTH_TOKEN=mytoken`) |
| `secret-envs` | List/CSV | List of [secret env vars](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret) to expose to the build (e.g., `key=envname`, `MY_SECRET=MY_ENV_VAR`) | | `secret-envs` | List/CSV | List of [secret env vars](https://docs.docker.com/build/ci/github-actions/secrets/) to expose to the build (e.g., `key=envname`, `MY_SECRET=MY_ENV_VAR`) |
| `secret-files` | List | List of [secret files](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret) to expose to the build (e.g., `key=filename`, `MY_SECRET=./secret.txt`) | | `secret-files` | List | List of [secret files](https://docs.docker.com/build/ci/github-actions/secrets/) to expose to the build (e.g., `key=filename`, `MY_SECRET=./secret.txt`) |
| `shm-size` | String | Size of [`/dev/shm`](https://docs.docker.com/engine/reference/commandline/buildx_build/#shm-size) (e.g., `2g`) | | `shm-size` | String | Size of [`/dev/shm`](https://docs.docker.com/engine/reference/commandline/buildx_build/#shm-size) (e.g., `2g`) |
| `ssh` | List | List of [SSH agent socket or keys](https://docs.docker.com/engine/reference/commandline/buildx_build/#ssh) to expose to the build | | `ssh` | List | List of [SSH agent socket or keys](https://docs.docker.com/engine/reference/commandline/buildx_build/#ssh) to expose to the build |
| `tags` | List/CSV | List of tags | | `tags` | List/CSV | List of tags |