actions/download-artifact
1
0
Fork 0
mirror of https://github.com/actions/download-artifact.git synced 2024-11-24 01:50:55 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

adopt new internal artifact api behavior

Browse source
This commit is contained in:
Rob Herley 2023-11-30 21:37:06 -05:00
parent 896d1bb258
commit 6ee005d6b7
No known key found for this signature in database
GPG key ID: D1602042C3543B06
2 changed files with 29 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
action.yml
View file

@ -9,21 +9,23 @@ inputs:
description: 'Destination path' description: 'Destination path'
required: false required: false
github-token: github-token:
description: The GitHub token used to download the artifact description: 'The GitHub token used to authenticate with the GitHub API.
default: ${{ github.token }} 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 required: false
repository: repository:
description: 'The repository owner and the repository name joined together by "/". description: 'The repository owner and the repository name joined together by "/".
This specifies the repository that artifacts will be downloaded from. If downloading artifacts from external workflow runs or repositories then the above download-token must be permissions to this repository.' If github-token is specified, this is the repository that artifacts will be downloaded from.'
required: false required: false
default: ${{ github.repository }} default: ${{ github.repository }}
run-id: run-id:
description: 'The id of the workflow run where the desired download artifact was uploaded from. If downloading artifacts from anything other than the current workflow run then this needs to be overwritten.' 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 required: false
default: ${{ github.run_id }} default: ${{ github.run_id }}
outputs: outputs:
download-path: download-path:
description: 'Path of artifact download' description: 'Path of artifact download'
runs: runs:
using: 'node16' using: 'node20'
main: 'dist/index.js' main: 'dist/index.js'

41
src/download-artifact.ts
View file

@ -17,9 +17,9 @@ async function run(): Promise<void> {
const inputs = { const inputs = {
name: core.getInput(Inputs.Name, {required: false}), name: core.getInput(Inputs.Name, {required: false}),
path: core.getInput(Inputs.Path, {required: false}), path: core.getInput(Inputs.Path, {required: false}),
token: core.getInput(Inputs.GitHubToken, {required: true}), token: core.getInput(Inputs.GitHubToken, {required: false}),
repository: core.getInput(Inputs.Repository, {required: true}), repository: core.getInput(Inputs.Repository, {required: false}),
runID: parseInt(core.getInput(Inputs.RunID, {required: true})) runID: parseInt(core.getInput(Inputs.RunID, {required: false}))
} }
if (!inputs.path) { if (!inputs.path) {
@ -33,11 +33,21 @@ async function run(): Promise<void> {
const resolvedPath = path.resolve(inputs.path) const resolvedPath = path.resolve(inputs.path)
core.debug(`Resolved path is ${resolvedPath}`) core.debug(`Resolved path is ${resolvedPath}`)
const [owner, repo] = inputs.repository.split('/') const options: artifact.FindOptions = {}
if (!owner || !repo) { if (inputs.token) {
throw new Error( const [repositoryOwner, repositoryName] = inputs.repository.split('/')
`Invalid repository: '${inputs.repository}'. Must be in format owner/repo` if (!repositoryOwner || !repositoryName) {
) throw new Error(
`Invalid repository: '${inputs.repository}'. Must be in format owner/repo`
)
}
options.findBy = {
token: inputs.token,
workflowRunId: inputs.runID,
repositoryName,
repositoryOwner
}
} }
const artifactClient = artifact.create() const artifactClient = artifact.create()
@ -46,10 +56,7 @@ async function run(): Promise<void> {
if (inputs.name) { if (inputs.name) {
const {artifact: targetArtifact} = await artifactClient.getArtifact( const {artifact: targetArtifact} = await artifactClient.getArtifact(
inputs.name, inputs.name,
inputs.runID, options
owner,
repo,
inputs.token
) )
if (!targetArtifact) { if (!targetArtifact) {
@ -62,12 +69,7 @@ async function run(): Promise<void> {
artifacts = [targetArtifact] artifacts = [targetArtifact]
} else { } else {
const listArtifactResponse = await artifactClient.listArtifacts( const listArtifactResponse = await artifactClient.listArtifacts(options)
inputs.runID,
owner,
repo,
inputs.token
)
if (listArtifactResponse.artifacts.length === 0) { if (listArtifactResponse.artifacts.length === 0) {
throw new Error( throw new Error(
@ -80,7 +82,8 @@ async function run(): Promise<void> {
} }
const downloadPromises = artifacts.map(artifact => const downloadPromises = artifacts.map(artifact =>
artifactClient.downloadArtifact(artifact.id, owner, repo, inputs.token, { artifactClient.downloadArtifact(artifact.id, {
...options,
path: path.join(resolvedPath, artifact.name) path: path.join(resolvedPath, artifact.name)
}) })
) )