neil/build-push-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify dockerfile and path inputs

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -86,11 +86,13 @@ Example:
### `path`
Path to run the docker build from. Defaults to `.`.
Path to the build context. Defaults to `.`
### `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`

4
action.yml
View File

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