Clarify dockerfile and path inputs

Clarify the documentation for the dockerfile and path action inputs
including how they relate to each other.

Signed-off-by: Nick Adcock <nick.adcock@docker.com>
This commit is contained in:
Nick Adcock 2020-03-20 13:15:06 +00:00
parent 434b33a73f
commit 120f6587bc
2 changed files with 6 additions and 4 deletions

View file

@ -86,11 +86,13 @@ Example:
### `path` ### `path`
Path to run the docker build from. Defaults to `.`. Path to the build context. Defaults to `.`
### `dockerfile` ### `dockerfile`
Name of the Dockerfile. Defaults to `{path}/Dockerfile`. Path to the Dockerfile. Defaults to `{path}/Dockerfile`
Note when set this path is **not** relative to the `path` input but is instead relative to the current working directory.
### `target` ### `target`

View file

@ -34,11 +34,11 @@ inputs:
required: false required: false
default: false default: false
path: path:
description: Path to run docker build from description: Path to the build context
required: false required: false
default: "." default: "."
dockerfile: dockerfile:
description: Name of the Dockerfile (Default is 'path/Dockerfile') description: Path to the Dockerfile (Default is '{path}/Dockerfile')
required: false required: false
target: target:
description: Sets the target stage to build description: Sets the target stage to build