From 120f6587bc21f7bd02c1f937edd2d06d9d8c1774 Mon Sep 17 00:00:00 2001
From: Nick Adcock <nick.adcock@docker.com>
Date: Fri, 20 Mar 2020 13:15:06 +0000
Subject: [PATCH] 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>
---
README.md | 6 ++++--
action.yml | 4 ++--
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index cac79a3..de81c4c 100644
--- 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
index 8b5a060..e336b90 100644
--- 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