Actions/download-artifact
1
Fork 0
mirror of https://github.com/actions/download-artifact.git synced 2025-08-15 05:05:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
GrantBirki 2025-08-05 10:59:33 -07:00
parent fff8c148a8
commit bff23f9308
No known key found for this signature in database
GPG Key ID: 65497A530F6F9405
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -8,6 +8,7 @@ See also [upload-artifact](https://github.com/actions/upload-artifact).
- [v4 - What's new](#v4---whats-new) - [v4 - What's new](#v4---whats-new)
- [Improvements](#improvements) - [Improvements](#improvements)
- [Breaking Changes](#breaking-changes) - [Breaking Changes](#breaking-changes)
- [Note](#note)
- [Usage](#usage) - [Usage](#usage)
- [Inputs](#inputs) - [Inputs](#inputs)
- [Outputs](#outputs) - [Outputs](#outputs)
@ -89,6 +90,7 @@ You are welcome to still raise bugs in this repo.
# When multiple artifacts are matched, this changes the behavior of the destination directories. # When multiple artifacts are matched, this changes the behavior of the destination directories.
# If true, the downloaded artifacts will be in the same directory specified by path. # If true, the downloaded artifacts will be in the same directory specified by path.
# If false, the downloaded artifacts will be extracted into individual named directories within the specified path. # If false, the downloaded artifacts will be extracted into individual named directories within the specified path.
# Note: When downloading a single artifact (by name or ID), it will always be extracted directly to the specified path.
# Optional. Default is 'false' # Optional. Default is 'false'
merge-multiple: merge-multiple:
@ -145,6 +147,8 @@ steps:
The `artifact-ids` input allows downloading artifacts using their unique ID rather than name. This is particularly useful when working with immutable artifacts from `actions/upload-artifact@v4` which assigns a unique ID to each artifact. The `artifact-ids` input allows downloading artifacts using their unique ID rather than name. This is particularly useful when working with immutable artifacts from `actions/upload-artifact@v4` which assigns a unique ID to each artifact.
Download a single artifact by ID to the current working directory (`$GITHUB_WORKSPACE`):
```yaml ```yaml
steps: steps:
- uses: actions/download-artifact@v4 - uses: actions/download-artifact@v4
@ -154,6 +158,20 @@ steps:
run: ls -R run: ls -R
``` ```
Download a single artifact by ID to a specific directory:
```yaml
steps:
- uses: actions/download-artifact@v4
with:
artifact-ids: 12345
path: your/destination/dir
- name: Display structure of downloaded files
run: ls -R your/destination/dir
```
When downloading a single artifact by ID, the behavior is identical to downloading by name - the artifact contents are extracted directly to the specified path without creating a subdirectory.
Multiple artifacts can be downloaded by providing a comma-separated list of IDs: Multiple artifacts can be downloaded by providing a comma-separated list of IDs:
```yaml ```yaml
@ -166,7 +184,7 @@ steps:
run: ls -R path/to/artifacts run: ls -R path/to/artifacts
``` ```
This will download multiple artifacts to separate directories (similar to downloading multiple artifacts by name). When downloading multiple artifacts by ID, each artifact will be extracted into its own subdirectory named after the artifact (similar to downloading multiple artifacts by name).
### Download All Artifacts ### Download All Artifacts