Skip to content
Permalink
Browse files

Update README with more retention documentation

  • Loading branch information
Konrad Pabjan GitHub
Konrad Pabjan authored and GitHub committed Nov 17, 2020
1 parent 726a6dc commit e4a7ffadfc58aadbd801abac31a52c2a675fa328
Showing with 19 additions and 19 deletions.
  1. +19 −19 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<br/>
<img src="https://user-images.githubusercontent.com/16109154/72556687-20235a80-386d-11ea-9e2a-b534faa77083.png" width="375" height="140">
@@ -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

0 comments on commit e4a7ffa

Please sign in to comment.
You can’t perform that action at this time.