mirror of
https://github.com/actions/download-artifact.git
synced 2025-07-27 08:58:28 +02:00
README updates
This commit is contained in:
parent
37d541d232
commit
539315322a
4 changed files with 21 additions and 9 deletions
21
README.md
21
README.md
|
@ -71,8 +71,7 @@ To maintain the same behavior for `v2`, you can set the `path` to the name of th
|
|||
|
||||
# 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.
|
||||
|
||||
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/
|
||||
|
@ -107,6 +106,24 @@ steps:
|
|||
run: ls -R
|
||||
```
|
||||
|
||||
# Download path output
|
||||
|
||||
Not sure where your artifact was downloaded to? The `download-path` step output can help you out. Just make sure to be aware of the extra directory that is created if downloading all artifacts (no name specified).
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- uses: actions/download-artifact@v2
|
||||
id: download
|
||||
with:
|
||||
name: 'my-artifact'
|
||||
path: path/to/artifacts
|
||||
|
||||
- name: 'Output download path'
|
||||
run: echo ${{steps.download.outputs.download-path}}
|
||||
```
|
||||
|
||||
# @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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue