1
0
mirror of https://github.com/actions/download-artifact.git synced 2025-12-06 01:37:50 +01:00

Compare commits

...

16 Commits

Author SHA1 Message Date
Salman Muin Kayser Chishti
c371ef827a update to node 24 runs on field 2025-09-29 14:11:41 +01:00
Salman Muin Kayser Chishti
660ddab92b audit fix 2025-09-29 13:53:42 +01:00
Salman Muin Kayser Chishti
67d513183b node24 2025-09-29 13:29:07 +01:00
Yang Cao
4a24838f3d Merge pull request #431 from danwkennedy/patch-1
Readme: spell out the first use of GHES
2025-09-24 09:48:26 -04:00
Daniel Kennedy
5e3251c4ff Readme: spell out the first use of GHES 2025-09-24 09:44:57 -04:00
Yang Cao
abefc31eaf Merge pull request #424 from actions/yacaovsnc/update_readme
Update README with artifact extraction details
2025-08-25 16:23:50 -04:00
Yang Cao
ac43a6070a Update README with artifact extraction details
Clarified note on artifact extraction and GHES support.
2025-08-25 14:32:17 -04:00
Yang Cao
de96f4613b Merge pull request #417 from actions/yacaovsnc/update_readme
Update README for download-artifact v5 changes
2025-08-06 09:03:16 -04:00
Yang Cao
7993cb44e9 Remove migration guide for artifact download changes
Readme probably should be less verbose since it's not a changelog.
2025-08-05 18:06:12 -04:00
Yang Cao
2653c123b8 Update README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-05 18:02:37 -04:00
Yang Cao
7d782037f3 Update README for download-artifact v5 changes
Updated documentation for download-artifact action to reflect changes in version 5.
2025-08-05 18:01:53 -04:00
Yang Cao
634f93cb29 Merge pull request #416 from actions/single-artifact-id-download-path
fix: inconsistent path behavior for single artifact downloads by ID
2025-08-05 16:50:54 -04:00
GrantBirki
b19ff43027 refactor: resolve download path correctly in artifact download tests (mainly for windows unit tests) 2025-08-05 11:26:03 -07:00
GrantBirki
e262cbee4a bundle dist 2025-08-05 11:00:44 -07:00
GrantBirki
bff23f9308 update docs 2025-08-05 10:59:33 -07:00
GrantBirki
fff8c148a8 fix download path logic when downloading a single artifact by id 2025-08-05 10:56:18 -07:00
12 changed files with 125207 additions and 108143 deletions

View File

@@ -18,10 +18,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
- name: Setup Node 20
uses: actions/setup-node@v4
uses: actions/setup-node@v5
with:
node-version: 20.x
cache: 'npm'

View File

@@ -20,7 +20,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v5
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL

View File

@@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
name: Check licenses
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
- run: npm ci
- name: Install licensed
run: |

View File

@@ -14,7 +14,7 @@ jobs:
steps:
- name: Checking out
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Publish
id: publish
uses: actions/publish-immutable-action@0.0.3

View File

@@ -20,10 +20,10 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Setup Node 20
uses: actions/setup-node@v4
uses: actions/setup-node@v5
with:
node-version: 20.x
cache: 'npm'

View File

@@ -5,9 +5,11 @@ Download [Actions Artifacts](https://docs.github.com/en/actions/using-workflows/
See also [upload-artifact](https://github.com/actions/upload-artifact).
- [`@actions/download-artifact`](#actionsdownload-artifact)
- [v5 - What's new](#v5---whats-new)
- [v4 - What's new](#v4---whats-new)
- [Improvements](#improvements)
- [Breaking Changes](#breaking-changes)
- [Note](#note)
- [Usage](#usage)
- [Inputs](#inputs)
- [Outputs](#outputs)
@@ -20,11 +22,24 @@ See also [upload-artifact](https://github.com/actions/upload-artifact).
- [Limitations](#limitations)
- [Permission Loss](#permission-loss)
## v5 - What's new
Previously, **single artifact downloads** behaved differently depending on how you specified the artifact:
- **By name**: `name: my-artifact` → extracted to `path/` (direct)
- **By ID**: `artifact-ids: 12345` → extracted to `path/my-artifact/` (nested)
Now both methods are consistent:
- **By name**: `name: my-artifact` → extracted to `path/` (unchanged)
- **By ID**: `artifact-ids: 12345` → extracted to `path/` (updated - now direct)
Note: This change also applies to patterns that only match a single artifact.
## v4 - What's new
> [!IMPORTANT]
> download-artifact@v4+ is not currently supported on GHES yet. If you are on GHES, you must use [v3](https://github.com/actions/download-artifact/releases/tag/v3).
> download-artifact@v4+ is not currently supported on GitHub Enterprise Server (GHES) yet. If you are on GHES, you must use [v3](https://github.com/actions/download-artifact/releases/tag/v3).
The release of upload-artifact@v4 and download-artifact@v4 are major changes to the backend architecture of Artifacts. They have numerous performance and behavioral improvements.
@@ -65,7 +80,7 @@ You are welcome to still raise bugs in this repo.
### Inputs
```yaml
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
# Name of the artifact to download.
# If unspecified, all artifacts for the run are downloaded.
@@ -89,6 +104,7 @@ You are welcome to still raise bugs in this repo.
# 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 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'
merge-multiple:
@@ -122,7 +138,7 @@ Download to current working directory (`$GITHUB_WORKSPACE`):
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
name: my-artifact
- name: Display structure of downloaded files
@@ -133,7 +149,7 @@ Download to a specific directory (also supports `~` expansion):
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
name: my-artifact
path: your/destination/dir
@@ -145,20 +161,36 @@ 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.
Download a single artifact by ID to the current working directory (`$GITHUB_WORKSPACE`):
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
artifact-ids: 12345
- name: Display structure of downloaded files
run: ls -R
```
Download a single artifact by ID to a specific directory:
```yaml
steps:
- uses: actions/download-artifact@v5
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:
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
artifact-ids: 12345,67890
path: path/to/artifacts
@@ -166,7 +198,7 @@ steps:
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
@@ -186,7 +218,7 @@ Download all artifacts to the current working directory:
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
- name: Display structure of downloaded files
run: ls -R
```
@@ -195,7 +227,7 @@ Download all artifacts to a specific directory:
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
path: path/to/artifacts
- name: Display structure of downloaded files
@@ -206,7 +238,7 @@ To download them to the _same_ directory:
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
path: path/to/artifacts
merge-multiple: true
@@ -246,7 +278,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Download All Artifacts
uses: actions/download-artifact@v4
uses: actions/download-artifact@v5
with:
path: my-artifact
pattern: my-artifact-*
@@ -269,7 +301,7 @@ It may be useful to download Artifacts from other workflow runs, or even other r
```yaml
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v5
with:
name: my-other-artifact
github-token: ${{ secrets.GH_PAT }} # token with actions:read permissions on target repo

View File

@@ -1,4 +1,5 @@
import * as core from '@actions/core'
import * as path from 'path'
import artifact, {ArtifactNotFoundError} from '@actions/artifact'
import {run} from '../src/download-artifact'
import {Inputs} from '../src/constants'
@@ -371,4 +372,38 @@ describe('download', () => {
"Inputs 'name' and 'artifact-ids' cannot be used together. Please specify only one."
)
})
test('downloads single artifact by ID to same path as by name', async () => {
const mockArtifact = {
id: 456,
name: 'test-artifact',
size: 1024,
digest: 'def456'
}
const testPath = '/test/path'
mockInputs({
[Inputs.Name]: '',
[Inputs.Pattern]: '',
[Inputs.ArtifactIds]: '456',
[Inputs.Path]: testPath
})
jest.spyOn(artifact, 'listArtifacts').mockImplementation(() =>
Promise.resolve({
artifacts: [mockArtifact]
})
)
await run()
// Verify it downloads directly to the specified path (not nested in artifact name subdirectory)
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
456,
expect.objectContaining({
path: path.resolve(testPath), // Should be the resolved path directly, not nested
expectedHash: mockArtifact.digest
})
)
})
})

View File

@@ -39,5 +39,5 @@ outputs:
download-path:
description: 'Path of artifact download'
runs:
using: 'node20'
using: 'node24'
main: 'dist/index.js'

218282
dist/index.js vendored

File diff suppressed because one or more lines are too long

14952
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -29,7 +29,7 @@
},
"homepage": "https://github.com/actions/download-artifact#readme",
"dependencies": {
"@actions/artifact": "^2.3.2",
"@actions/artifact": "file:../packages/artifact",
"@actions/core": "^1.10.1",
"@actions/github": "^5.1.1",
"minimatch": "^9.0.3"
@@ -48,5 +48,8 @@
"ts-jest": "^29.2.6",
"ts-node": "^10.9.2",
"typescript": "^5.3.3"
},
"overrides": {
"uri-js": "npm:uri-js-replace@^1.0.1"
}
}

View File

@@ -174,7 +174,9 @@ export async function run(): Promise<void> {
promise: artifactClient.downloadArtifact(artifact.id, {
...options,
path:
isSingleArtifactDownload || inputs.mergeMultiple
isSingleArtifactDownload ||
inputs.mergeMultiple ||
artifacts.length === 1
? resolvedPath
: path.join(resolvedPath, artifact.name),
expectedHash: artifact.digest