actions / actions/toolkit

Download from a different workflow

Open
#501 3 comments 87 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

artifact enhancement
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Describe the enhancement

Add support for downloading artifacts from other workflows and/or previous workflow runs.

Code Snippet

Adding an optional parameter that defines search criteria would provide the ability to reference other workflows and previous executions as necessary. For example:

// Representative new behavior
const previousWorkflowRunCriteria : WorkflowCriteria = {
    branch: 'master',
    event: 'push',
    status: 'success'
}
const artifactsFromPreviousRunOfThisWorkflow = await artifactClient.downloadAllArtifacts(path, previousWorkflowRunCriteria)

const anotherWorkflowCriteria : WorkflowCriteria = {
    owner: 'owenfarrell',
    repo: 'vscode-vault',
    workflow: 'Build'
}
const artifactsFromAnotherWorkflow = await artifactClient.downloadAllArtifacts(path, anotherWorkflowCriteria)

// Existing behavior
const artifactsFromThisRunOfThisWorkflow = await artifactClient.downloadAllArtifacts(path)

Additional information

Per the report in https://github.com/actions/download-artifact/issues/3, a common use case amongst GitHub Actions users is to download an artifact from a previous run (or from another workflow altogether). This request serves as a precursor to resolving the linked issue above.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the artifactClient.downloadAllArtifacts API shown in the issue and review the linked actions/download-artifact issue for the motivating use cases. Define how WorkflowCriteria should identify prior runs and other workflows, then confirm that existing calls without criteria retain their current behavior. The payload names no files or tests, so repository exploration is required.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.