Clarify dockerfile and path inputs #16
Conversation
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>
| 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. |
There was a problem hiding this comment.
This is really confusing. If the path is . then it is relative to the path. What do you mean exactly?
There was a problem hiding this comment.
Do you mean "if you change it from the default it is relative to the current working directory not the path"?
There was a problem hiding this comment.
Yeah pretty much.
path: path/to/wherever
dockerfile: my/Dockerfile
Is equivalent to docker --file my/Dockerfile path/to/wherever which would mean your directory structure looked something like:
.
- my/
- Dockerfile
- path/
- to/
- wherever/
"Path to the Dockerfile. Defaults to {path}/Dockerfile" Is pretty much a copy/paste of the docker help build output:
-f, --file string Name of the Dockerfile (Default is
'PATH/Dockerfile')
Happy to change to something more clear if you have better wording
There was a problem hiding this comment.
I think its ok for now, I think however you explain it it might be confusing...
Clarify the documentation for the dockerfile and path action inputs including how they relate to each other.
Fixes #11