Skip to content

Commit de96f46

Browse files
yacaovsncyacaovsnc
authored
Merge pull request #417 from actions/yacaovsnc/update_readme
Update README for download-artifact v5 changes
2 parents 634f93c + 7993cb4 commit de96f46

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Download [Actions Artifacts](https://docs.github.com/en/actions/using-workflows/
55
See also [upload-artifact](https://github.com/actions/upload-artifact).
66

77
- [`@actions/download-artifact`](#actionsdownload-artifact)
8+
- [v5 - What's new](#v5---whats-new)
89
- [v4 - What's new](#v4---whats-new)
910
- [Improvements](#improvements)
1011
- [Breaking Changes](#breaking-changes)
@@ -21,6 +22,17 @@ See also [upload-artifact](https://github.com/actions/upload-artifact).
2122
- [Limitations](#limitations)
2223
- [Permission Loss](#permission-loss)
2324

25+
## v5 - What's new
26+
27+
Previously, **single artifact downloads** behaved differently depending on how you specified the artifact:
28+
29+
- **By name**: `name: my-artifact` → extracted to `path/` (direct)
30+
- **By ID**: `artifact-ids: 12345` → extracted to `path/my-artifact/` (nested)
31+
32+
Now both methods are consistent:
33+
34+
- **By name**: `name: my-artifact` → extracted to `path/` (unchanged)
35+
- **By ID**: `artifact-ids: 12345` → extracted to `path/` (updated - now direct)
2436

2537
## v4 - What's new
2638

@@ -66,7 +78,7 @@ You are welcome to still raise bugs in this repo.
6678
### Inputs
6779

6880
```yaml
69-
- uses: actions/download-artifact@v4
81+
- uses: actions/download-artifact@v5
7082
with:
7183
# Name of the artifact to download.
7284
# If unspecified, all artifacts for the run are downloaded.
@@ -124,7 +136,7 @@ Download to current working directory (`$GITHUB_WORKSPACE`):
124136

125137
```yaml
126138
steps:
127-
- uses: actions/download-artifact@v4
139+
- uses: actions/download-artifact@v5
128140
with:
129141
name: my-artifact
130142
- name: Display structure of downloaded files
@@ -135,7 +147,7 @@ Download to a specific directory (also supports `~` expansion):
135147

136148
```yaml
137149
steps:
138-
- uses: actions/download-artifact@v4
150+
- uses: actions/download-artifact@v5
139151
with:
140152
name: my-artifact
141153
path: your/destination/dir
@@ -151,7 +163,7 @@ Download a single artifact by ID to the current working directory (`$GITHUB_WORK
151163

152164
```yaml
153165
steps:
154-
- uses: actions/download-artifact@v4
166+
- uses: actions/download-artifact@v5
155167
with:
156168
artifact-ids: 12345
157169
- name: Display structure of downloaded files
@@ -162,7 +174,7 @@ Download a single artifact by ID to a specific directory:
162174

163175
```yaml
164176
steps:
165-
- uses: actions/download-artifact@v4
177+
- uses: actions/download-artifact@v5
166178
with:
167179
artifact-ids: 12345
168180
path: your/destination/dir
@@ -176,7 +188,7 @@ Multiple artifacts can be downloaded by providing a comma-separated list of IDs:
176188

177189
```yaml
178190
steps:
179-
- uses: actions/download-artifact@v4
191+
- uses: actions/download-artifact@v5
180192
with:
181193
artifact-ids: 12345,67890
182194
path: path/to/artifacts
@@ -204,7 +216,7 @@ Download all artifacts to the current working directory:
204216

205217
```yaml
206218
steps:
207-
- uses: actions/download-artifact@v4
219+
- uses: actions/download-artifact@v5
208220
- name: Display structure of downloaded files
209221
run: ls -R
210222
```
@@ -213,7 +225,7 @@ Download all artifacts to a specific directory:
213225

214226
```yaml
215227
steps:
216-
- uses: actions/download-artifact@v4
228+
- uses: actions/download-artifact@v5
217229
with:
218230
path: path/to/artifacts
219231
- name: Display structure of downloaded files
@@ -224,7 +236,7 @@ To download them to the _same_ directory:
224236

225237
```yaml
226238
steps:
227-
- uses: actions/download-artifact@v4
239+
- uses: actions/download-artifact@v5
228240
with:
229241
path: path/to/artifacts
230242
merge-multiple: true
@@ -264,7 +276,7 @@ jobs:
264276
runs-on: ubuntu-latest
265277
steps:
266278
- name: Download All Artifacts
267-
uses: actions/download-artifact@v4
279+
uses: actions/download-artifact@v5
268280
with:
269281
path: my-artifact
270282
pattern: my-artifact-*
@@ -287,7 +299,7 @@ It may be useful to download Artifacts from other workflow runs, or even other r
287299

288300
```yaml
289301
steps:
290-
- uses: actions/download-artifact@v4
302+
- uses: actions/download-artifact@v5
291303
with:
292304
name: my-other-artifact
293305
github-token: ${{ secrets.GH_PAT }} # token with actions:read permissions on target repo

0 commit comments

Comments
 (0)