Skip to content

Commit

Permalink
Clarify dockerfile and path inputs
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
zappy-shu committed Mar 20, 2020
1 parent 434b33a commit 120f658
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 120f658

Please sign in to comment.