download-artifact/README.md

75 lines
1.6 KiB
Markdown
Raw Normal View History

# Download-Artifact v2 Preview
2019-07-24 03:28:49 +08:00
This downloads artifacts from your build
2019-07-24 03:28:49 +08:00
2019-09-09 13:37:19 +08:00
See also [upload-artifact](https://github.com/actions/upload-artifact).
2019-07-24 03:28:49 +08:00
# Usage
See [action.yml](action.yml)
# Download a Single Artifact
Basic (download to the current working directory):
2019-07-24 03:28:49 +08:00
```yaml
2019-07-26 09:31:50 +08:00
steps:
- uses: actions/checkout@v2
2019-07-24 03:28:49 +08:00
- uses: actions/download-artifact@v2-preview
2019-07-24 03:28:49 +08:00
with:
name: my-artifact
- run: cat my-artifact
```
Download to a specific directory:
2019-07-24 03:28:49 +08:00
```yaml
2019-07-26 09:31:50 +08:00
steps:
- uses: actions/checkout@v2
2019-07-24 03:28:49 +08:00
- uses: actions/download-artifact@v2-preview
2019-07-24 03:28:49 +08:00
with:
name: my-artifact
path: path/to/artifact
2019-07-24 03:34:36 +08:00
- run: cat path/to/artifact
2019-07-24 03:28:49 +08:00
```
# 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.
2020-04-28 17:43:05 +08:00
Example, if there are two artifacts `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
```
2019-07-24 03:28:49 +08:00
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)