download-artifact/README.md

93 lines
2.3 KiB
Markdown
Raw Normal View History

# Download-Artifact v2
2019-07-23 19:28:49 +00:00
This downloads artifacts from your build
2019-07-23 19:28:49 +00:00
2019-09-09 05:37:19 +00:00
See also [upload-artifact](https://github.com/actions/upload-artifact).
# What's new
- Download all artifacts at once
- Port entire action to typescript from a runner plugin so it is easier to collaborate and accept contributions
Refer [here](https://github.com/actions/download-artifact/tree/v1) for the previous version
2019-07-23 19:28:49 +00:00
# Usage
See [action.yml](action.yml)
# Download a Single Artifact
Basic (download to the current working directory):
2019-07-23 19:28:49 +00:00
```yaml
2019-07-26 01:31:50 +00:00
steps:
- uses: actions/checkout@v2
2019-07-23 19:28:49 +00:00
- uses: actions/download-artifact@v2
2019-07-23 19:28:49 +00:00
with:
name: my-artifact
- name: Display structure of downloaded files
run: ls -R
2019-07-23 19:28:49 +00:00
```
Download to a specific directory:
2019-07-23 19:28:49 +00:00
```yaml
2019-07-26 01:31:50 +00:00
steps:
- uses: actions/checkout@v2
2019-07-23 19:28:49 +00:00
- uses: actions/download-artifact@v2
2019-07-23 19:28:49 +00:00
with:
name: my-artifact
path: path/to/artifact
- name: Display structure of downloaded files
run: ls -R
working-directory: path/to/artifact
2019-07-23 19:28:49 +00: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.
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
with:
path: path/to/artifacts
- name: Display structure of downloaded files
run: ls -R
working-directory: path/to/artifacts
```
Download all artifacts to the current working directory
```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/download-artifact@v2
- name: Display structure of downloaded files
run: ls -R
```
# @actions/artifact package
Internally the [@actions/artifact](https://github.com/actions/toolkit/tree/master/packages/artifact) NPM package is used to interact with artifacts. You can find additional documentation there along with all the source code related to artifact download.
2019-07-23 19:28:49 +00:00
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)