download-artifact/action.yml

45 lines
2 KiB
YAML
Raw Normal View History

2019-11-08 17:00:32 +00:00
name: 'Download a Build Artifact'
description: 'Download a build artifact that was previously uploaded in the workflow by the upload-artifact action'
2019-06-24 20:40:04 +00:00
author: 'GitHub'
inputs:
2019-06-24 20:40:04 +00:00
name:
description: 'Name of the artifact to download. If unspecified, all artifacts for the run are downloaded.'
required: false
2019-06-24 20:40:04 +00:00
path:
2023-12-13 00:21:23 +00:00
description: 'Destination path. Supports basic tilde expansion. Defaults to $GITHUB_WORKSPACE'
required: false
pattern:
description: 'A glob pattern matching the artifacts that should be downloaded. Ignored if name is specified.'
required: false
2024-02-07 22:18:31 +00:00
max-attempts:
description: 'Maximum number of attempts while retrying download.'
required: false
default: '5'
merge-multiple:
description: '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.'
required: false
default: 'false'
github-token:
2023-12-01 18:20:09 +00:00
description: '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.'
required: false
repository:
description: 'The repository owner and the repository name joined together by "/".
2023-12-01 18:20:09 +00:00
If github-token is specified, this is the repository that artifacts will be downloaded from.'
required: false
default: ${{ github.repository }}
run-id:
2023-12-01 18:20:09 +00:00
description: '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.'
required: false
default: ${{ github.run_id }}
outputs:
download-path:
description: 'Path of artifact download'
2019-06-24 20:40:04 +00:00
runs:
using: 'node20'
main: 'dist/index.js'