Skip to content

Commit 120f658

Browse files
committed
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>
1 parent 434b33a commit 120f658

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,13 @@ Example:
8686

8787
### `path`
8888

89-
Path to run the docker build from. Defaults to `.`.
89+
Path to the build context. Defaults to `.`
9090

9191
### `dockerfile`
9292

93-
Name of the Dockerfile. Defaults to `{path}/Dockerfile`.
93+
Path to the Dockerfile. Defaults to `{path}/Dockerfile`
94+
95+
Note when set this path is **not** relative to the `path` input but is instead relative to the current working directory.
9496

9597
### `target`
9698

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ inputs:
3434
required: false
3535
default: false
3636
path:
37-
description: Path to run docker build from
37+
description: Path to the build context
3838
required: false
3939
default: "."
4040
dockerfile:
41-
description: Name of the Dockerfile (Default is 'path/Dockerfile')
41+
description: Path to the Dockerfile (Default is '{path}/Dockerfile')
4242
required: false
4343
target:
4444
description: Sets the target stage to build

0 commit comments

Comments
 (0)