1
0
Fork 0
mirror of https://github.com/docker/build-push-action.git synced 2025-04-01 20:50:09 +02:00

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 <me@johnhame.link>
This commit is contained in:
John Hamelink 2021-08-05 20:33:55 +01:00
parent 09d66c261a
commit b2404e6e8f
No known key found for this signature in database
GPG key ID: 153DDFE9A54A9A4C

View file

@ -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 |