From b2404e6e8f155da9f458afa1c11fd095e1b0cf1b Mon Sep 17 00:00:00 2001 From: John Hamelink Date: Thu, 5 Aug 2021 20:33:55 +0100 Subject: [PATCH] Improve documentation around the `ssh` parameter This change adds clarity on how to use the `ssh` parameter to pass in either an SSH agent socket, or to a file. This is obvious if you've used docker build manually, but not so much if you aren't familiar with how the command line options work. Signed-off-by: John Hamelink --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b01316..7e63e26 100644 --- a/README.md +++ b/README.md @@ -205,7 +205,7 @@ Following inputs can be used as `step.with` keys | `push` | Bool | [Push](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#push) is a shorthand for `--output=type=registry` (default `false`) | | `secrets` | List | List of secrets to expose to the build (eg. `key=string`, `GIT_AUTH_TOKEN=mytoken`) | | `secret-files` | List | List of secret files to expose to the build (eg. `key=filename`, `MY_SECRET=./secret.txt`) | -| `ssh` | List | List of SSH agent socket or keys to expose to the build | +| `ssh` | List | List of paths to SSH agent sockets or to keys you wish to expose to the build (eg. `default=/tmp/ssh-socket`) | | `tags` | List/CSV | List of tags | | `target` | String | Sets the target stage to build |