Update README.md

This commit is contained in:
Konrad Pabjan 2020-02-21 09:34:39 -05:00 committed by GitHub
parent 9994975c77
commit 7ede1c07b6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,6 @@
# download-artifact
# Download-Artifact v2 Preview
This downloads artifacts from your build.
This downloads artifacts from your build
See also [upload-artifact](https://github.com/actions/upload-artifact).
@ -8,31 +8,66 @@ See also [upload-artifact](https://github.com/actions/upload-artifact).
See [action.yml](action.yml)
Basic (download to current working directory):
# Download a Single Artifact
Basic (download to the current working directory):
```yaml
steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v2
- uses: actions/download-artifact@v1
- uses: actions/download-artifact@v2-preview
with:
name: my-artifact
- run: cat my-artifact
```
Download to specific directory:
Download to a specific directory:
```yaml
steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v2
- uses: actions/download-artifact@v1
- uses: actions/download-artifact@v2-preview
with:
name: my-artifact
path: path/to/artifact
- run: cat path/to/artifact
```
# Download All Artifacts
If the `name` input parameter is not provided, all artifacts will be downloaded. To differentiate between downloaded artifacts, a directory denoted by the artifacts name will be created for each individual artifact.
Example, if there are two artfiacts `Artifact-A` and `Artifact-B`, and the directory is `etc/usr/artifacts/`, the directory structure will look like this:
```
etc/usr/artifacts/
Artifact-A/
... contents of Artifact-A
Artifact-B/
... contents of Artifact-B
```
Download all artifacts to a specific directory
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/download-artifact@v2-preview
with:
path: path/to/artifacts
- run: cat path/to/artifacts
```
Download all artifacts to the current working directory
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/download-artifact@v2-preview
```
# License