Merge pull request #16 from docker/clarify-paths

Clarify dockerfile and path inputs
docker · Mar 23, 2020 · 57a738d · 57a738d
2 parents 434b33a + 120f658
commit 57a738d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -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`
 

diff --git a/action.yml b/action.yml
@@ -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