set new 'latest' attribute for list operations

Bump to latest artifact version from toolkit

action.yml

@@ -1,13 +1,31 @@
 name: 'Download a Build Artifact'
 description: 'Download a build artifact that was previously uploaded in the workflow by the upload-artifact action'
 author: 'GitHub'
-inputs: 
+inputs:
   name:
     description: 'Artifact name'
     required: false
   path:
     description: 'Destination path'
     required: false
+  github-token:
+    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 "/".
+      If github-token is specified, this is the repository that artifacts will be downloaded from.'
+    required: false
+    default: ${{ github.repository }}
+  run-id:
+    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'
 runs:
   using: 'node20'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "download-artifact",
-  "version": "3.1.0",
+  "version": "3.0.0",
   "description": "Download a build artifact that was previously uploaded in the workflow by the upload-artifact action",
   "main": "dist/index.js",
   "scripts": {
@@ -28,8 +28,9 @@
   },
   "homepage": "https://github.com/actions/download-artifact#readme",
   "dependencies": {
-    "@actions/artifact": "^1.1.3",
-    "@actions/core": "^1.10.0"
+    "@actions/artifact": "^2.0.0",
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1"
   },
   "devDependencies": {
     "@types/node": "^12.12.6",
@@ -41,4 +42,4 @@
     "prettier": "^2.0.5",
     "typescript": "^3.8.3"
   }
-}
+}

src/constants.ts

@@ -1,7 +1,11 @@
 export enum Inputs {
   Name = 'name',
-  Path = 'path'
+  Path = 'path',
+  GitHubToken = 'github-token',
+  Repository = 'repository',
+  RunID = 'run-id'
 }
+
 export enum Outputs {
   DownloadPath = 'download-path'
 }

src/download-artifact.ts

@@ -1,61 +1,115 @@
+import * as os from 'os'
+import * as path from 'path'
 import * as core from '@actions/core'
 import * as artifact from '@actions/artifact'
-import * as os from 'os'
-import {resolve} from 'path'
 import {Inputs, Outputs} from './constants'
 
+const PARALLEL_DOWNLOADS = 5
+
+export const chunk = <T>(arr: T[], n: number): T[][] =>
+  arr.reduce((acc, cur, i) => {
+    const index = Math.floor(i / n)
+    acc[index] = [...(acc[index] || []), cur]
+    return acc
+  }, [] as T[][])
+
 async function run(): Promise<void> {
-  try {
-    const name = core.getInput(Inputs.Name, {required: false})
-    const path = core.getInput(Inputs.Path, {required: false})
-
-    let resolvedPath
-    // resolve tilde expansions, path.replace only replaces the first occurrence of a pattern
-    if (path.startsWith(`~`)) {
-      resolvedPath = resolve(path.replace('~', os.homedir()))
-    } else {
-      resolvedPath = resolve(path)
-    }
-    core.debug(`Resolved path is ${resolvedPath}`)
-
-    const artifactClient = artifact.create()
-    if (!name) {
-      // download all artifacts
-      core.info('No artifact name specified, downloading all artifacts')
-      core.info(
-        'Creating an extra directory for each artifact that is being downloaded'
-      )
-      const downloadResponse = await artifactClient.downloadAllArtifacts(
-        resolvedPath
-      )
-      core.info(`There were ${downloadResponse.length} artifacts downloaded`)
-      for (const artifact of downloadResponse) {
-        core.info(
-          `Artifact ${artifact.artifactName} was downloaded to ${artifact.downloadPath}`
-        )
-      }
-    } else {
-      // download a single artifact
-      core.info(`Starting download for ${name}`)
-      const downloadOptions = {
-        createArtifactFolder: false
-      }
-      const downloadResponse = await artifactClient.downloadArtifact(
-        name,
-        resolvedPath,
-        downloadOptions
-      )
-      core.info(
-        `Artifact ${downloadResponse.artifactName} was downloaded to ${downloadResponse.downloadPath}`
-      )
-    }
-    // output the directory that the artifact(s) was/were downloaded to
-    // if no path is provided, an empty string resolves to the current working directory
-    core.setOutput(Outputs.DownloadPath, resolvedPath)
-    core.info('Artifact download has finished successfully')
-  } catch (err) {
-    core.setFailed(err.message)
+  const inputs = {
+    name: core.getInput(Inputs.Name, {required: false}),
+    path: core.getInput(Inputs.Path, {required: false}),
+    token: core.getInput(Inputs.GitHubToken, {required: false}),
+    repository: core.getInput(Inputs.Repository, {required: false}),
+    runID: parseInt(core.getInput(Inputs.RunID, {required: false}))
   }
+
+  if (!inputs.path) {
+    inputs.path = process.env['GITHUB_WORKSPACE'] || process.cwd()
+  }
+
+  if (inputs.path.startsWith(`~`)) {
+    inputs.path = inputs.path.replace('~', os.homedir())
+  }
+
+  const isSingleArtifactDownload = !!inputs.name
+  const resolvedPath = path.resolve(inputs.path)
+  core.debug(`Resolved path is ${resolvedPath}`)
+
+  const options: artifact.FindOptions = {}
+  if (inputs.token) {
+    const [repositoryOwner, repositoryName] = inputs.repository.split('/')
+    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()
+  let artifacts: artifact.Artifact[] = []
+
+  if (isSingleArtifactDownload) {
+    core.info(`Downloading single artifact`)
+
+    const {artifact: targetArtifact} = await artifactClient.getArtifact(
+      inputs.name,
+      options
+    )
+
+    if (!targetArtifact) {
+      throw new Error(`Artifact '${inputs.name}' not found`)
+    }
+
+    core.debug(
+      `Found named artifact '${inputs.name}' (ID: ${targetArtifact.id}, Size: ${targetArtifact.size})`
+    )
+
+    artifacts = [targetArtifact]
+  } else {
+    core.info(
+      `No input name specified, downloading all artifacts. Extra directory with the artifact name will be created for each download`
+    )
+
+    const listArtifactResponse = await artifactClient.listArtifacts({
+      latest: true,
+      ...options
+    })
+
+    if (listArtifactResponse.artifacts.length === 0) {
+      throw new Error(
+        `No artifacts found for run '${inputs.runID}' in '${inputs.repository}'`
+      )
+    }
+
+    core.debug(`Found ${listArtifactResponse.artifacts.length} artifacts`)
+    artifacts = listArtifactResponse.artifacts
+  }
+
+  const downloadPromises = artifacts.map(artifact =>
+    artifactClient.downloadArtifact(artifact.id, {
+      ...options,
+      path: isSingleArtifactDownload
+        ? resolvedPath
+        : path.join(resolvedPath, artifact.name)
+    })
+  )
+
+  const chunkedPromises = chunk(downloadPromises, PARALLEL_DOWNLOADS)
+  for (const chunk of chunkedPromises) {
+    await Promise.all(chunk)
+  }
+
+  core.info(`Total of ${artifacts.length} artifact(s) downloaded`)
+  core.setOutput(Outputs.DownloadPath, resolvedPath)
+  core.info('Download artifact has finished successfully')
 }
 
-run()
+run().catch(err =>
+  core.setFailed(`Unable to download artifact(s): ${err.message}`)
+)