From 0fd75946627114db493fce85b614ddf4470d37b5 Mon Sep 17 00:00:00 2001
From: Konrad Pabjan <kopabjan@microsoft.com>
Date: Tue, 28 Jul 2020 14:47:03 +0200
Subject: [PATCH] README updates

---
 README.md           | 12 ++++++++++++
 dist/index.js       |  2 +-
 src/input-helper.ts |  4 +++-
 3 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1f1e3eb..1123678 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,18 @@ Relative and absolute file paths are both allowed. Relative paths are rooted aga
 
 The [@actions/artifact](https://github.com/actions/toolkit/tree/main/packages/artifact) package is used internally to handle most of the logic around uploading an artifact. There is extra documentation around upload limitations and behavior in the toolkit repo that is worth checking out.
 
+### Customization if no files are found
+
+If a path (or paths), result in no files being found for the artifact, the action will succeed but print out a warning. In certain scenarios it may be desirable to fail the action or suppress the warning. The `if-no-files-found` option allows you to customize the behavior of the action if no files are found.
+
+```yaml
+- uses: actions/upload-artifact@v2
+  with:
+    name: my-artifact
+    path: path/to/artifact/
+    if-no-files-found: error # 'warn' or 'suppress' are also available, defaults to `warn` 
+```
+
 ### Conditional Artifact Upload
 
 To upload artifacts only when the previous step of a job failed, use [`if: failure()`](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions#job-status-check-functions):
diff --git a/dist/index.js b/dist/index.js
index be85b72..ee36e68 100644
--- a/dist/index.js
+++ b/dist/index.js
@@ -6375,7 +6375,7 @@ function getInputs() {
     const ifNoFilesFound = core.getInput(constants_1.Inputs.IfNoFilesFound);
     const noFileBehavior = constants_1.NoFileOptions[ifNoFilesFound];
     if (!noFileBehavior) {
-        core.setFailed(`Unrecognized if-no-files-found input. Provided ${ifNoFilesFound}. Available options: ${Object.keys(constants_1.NoFileOptions)}`);
+        core.setFailed(`Unrecognized ${constants_1.Inputs.IfNoFilesFound} input. Provided: ${ifNoFilesFound}. Available options: ${Object.keys(constants_1.NoFileOptions)}`);
     }
     return {
         artifactName: name,
diff --git a/src/input-helper.ts b/src/input-helper.ts
index 76b536d..c58d52a 100644
--- a/src/input-helper.ts
+++ b/src/input-helper.ts
@@ -14,7 +14,9 @@ export function getInputs(): UploadInputs {
 
   if (!noFileBehavior) {
     core.setFailed(
-      `Unrecognized if-no-files-found input. Provided ${ifNoFilesFound}. Available options: ${Object.keys(
+      `Unrecognized ${
+        Inputs.IfNoFilesFound
+      } input. Provided: ${ifNoFilesFound}. Available options: ${Object.keys(
         NoFileOptions
       )}`
     )