From 40b305282182ab3d3265c0c45fd82dee1e605ace Mon Sep 17 00:00:00 2001
From: Rob Herley <robherley@github.com>
Date: Thu, 18 Jan 2024 13:44:36 -0500
Subject: [PATCH] update readme
---
README.md | 6 ++++++
action.yml | 2 +-
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5d8f205..a646864 100644
--- a/README.md
+++ b/README.md
@@ -93,6 +93,12 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
# Optional. Default is '6'
compression-level:
+
+ # If true, an artifact with a matching name will be deleted before a new one is uploaded.
+ # If false, the action will fail if an artifact for the given name already exists.
+ # Does not fail if the artifact does not exist.
+ # Optional. Default is 'false'
+ overwrite:
```
### Outputs
diff --git a/action.yml b/action.yml
index 6244f94..7cb5ad9 100644
--- a/action.yml
+++ b/action.yml
@@ -36,7 +36,7 @@ inputs:
default: '6'
overwrite:
description: >
- If true, an artifact matching name will be deleted before a new one is uploaded.
+ If true, an artifact with a matching name will be deleted before a new one is uploaded.
If false, the action will fail if an artifact for the given name already exists.
Does not fail if the artifact does not exist.
default: 'false'