actions/Download a Build Artifact
Download a build artifact that was previously uploaded in the workflow by the upload-artifact action
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| name | Name of the artifact to download. If unspecified, all artifacts for the run are downloaded. | no | — |
| artifact-ids | IDs of the artifacts to download, comma-separated. Either inputs `artifact-ids` or `name` can be used, but not both. | no | — |
| path | Destination path. Supports basic tilde expansion. Defaults to $GITHUB_WORKSPACE | no | — |
| pattern | A glob pattern matching the artifacts that should be downloaded. Ignored if name is specified. | no | — |
| merge-multiple | 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. | no | false |
| github-token | The GitHub token used to authenticate with the GitHub API. This is required when downloading artifacts from a different repository or from a different workflow run. If this is not specified, the action will attempt to download artifacts from the current repository and the current workflow run. | no | — |
| repository | The repository owner and the repository name joined together by "/". If github-token is specified, this is the repository that artifacts will be downloaded from. | no | ${{ github.repository }} |
| run-id | The id of the workflow run where the desired download artifact was uploaded from. If github-token is specified, this is the run that artifacts will be downloaded from. | no | ${{ github.run_id }} |
| skip-decompress | If true, the downloaded artifact will not be automatically extracted/decompressed. This is useful when you want to handle the artifact as-is without extraction. | no | false |
| digest-mismatch | The behavior when a downloaded artifact's digest does not match the expected digest. Options: ignore, info, warn, error. Default is error which will fail the action. | no | error |
Outputs
| name | description |
|---|---|
| download-path | Path of artifact download |