From e4a7ffadfc58aadbd801abac31a52c2a675fa328 Mon Sep 17 00:00:00 2001 From: Konrad Pabjan Date: Tue, 17 Nov 2020 12:57:17 -0500 Subject: [PATCH] Update README with more retention documentation --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 07e61db..bbbbf4b 100644 --- a/README.md +++ b/README.md @@ -199,6 +199,25 @@ Environment variables along with context expressions can also be used for input. path: ${{ github.workspace }}/artifact/**/* ``` +### Retention Period + +Artifacts are retained for 90 days by default. You can specify a shorter retention period using the `retention-days` input: + +```yaml + - name: 'Create a file' + run: echo "I won't live long" > my_file.txt + + - name: 'Upload Artifact' + uses: actions/upload-artifact@v2 + with: + name: my-artifact + path: my_file.txt + retention-days: 5 + +``` + +The retention period must be between 1 and 90 inclusive. For more information see [artifact and log retention policies](https://docs.github.com/en/free-pro-team@latest/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy). + ## Where does the upload go? In the top right corner of a workflow run, once the run is over, if you used this action, there will be an `Artifacts` dropdown which you can download items from. Here's a screenshot of what it looks like
@@ -234,25 +253,6 @@ If file permissions and case sensitivity are required, you can `tar` all of your path: my_files.tar ``` -### Retention Period - -Artifacts are retained for 90 days by default. You can specify a shorter retention period: - -```yaml - - name: 'Create a file' - run: echo "I won't live long" > my_file.txt - - - name: 'Upload Artifact' - uses: actions/upload-artifact@v2 - with: - name: my-artifact - path: my_file.txt - retention-days: 5 - -``` - -The retention period must be between 1 and 90 inclusive. - ## Additional Documentation