dawidd6/action-download-artifact

The action-download-artifact action allows you to download workflow artifacts from GitHub Actions. It supports downloading from the current workflow, specific workflows, or searching for runs based on various criteria like branch, commit, PR, or event type.

Required Inputs

• github_token: A GitHub token. Use a Personal Access Token (PAT) with repo scope if the repository is private or if you need to access artifacts from a different repository. A PAT with public_repo scope is required for public repositories.
• repo: The owner/repository in owner/repo format.
• path: The local directory where artifacts should be downloaded and/or unpacked.

Key Optional Inputs

• name: The name of the artifact to download. Supports exact matches or Regular Expressions if name_is_regexp is set to true.
• workflow: The workflow name or ID to search in.
• workflow_search: If true, the action will search for the most recent workflow matching the criteria if workflow is not specified.
• workflow_conclusion: Filter runs by their conclusion (e.g., success, failure, cancelled).
• run_id: The specific GitHub Run ID to target.
• skip_unpack: If true, the action downloads the .zip file but does not extract it.
• use_unzip: If true, uses the system unzip command instead of the internal adm-zip library for extraction.
• merge_multiple: If true and multiple artifacts match the name (via regex), they will all be extracted into the same directory specified by path instead of individual subdirectories.

Use the following inputs to configure how the action searches for and downloads artifacts:

Authentication

• github_token: (Required if downloading from a different repo or a private repo) A GitHub token or Personal Access Token. For private repos, a token with repo scope is required. For jobs with actions scope set to read, a standard GitHub token may suffice.

Workflow Selection

• workflow: (Optional) The workflow file name or ID. If not specified, it is inferred from run_id or defaults to the current workflow.
• workflow_search: (Optional) If true, and no workflow is set, the action searches for the most recent workflow matching other criteria.
• workflow_conclusion: (Optional) Search for a specific workflow conclusion (e.g., success, failure, neutral, cancelled, skipped, timed_out, action_required) or status (completed, in_progress, queued). Use an empty string "" to ignore status/conclusion.
• run_id: (Optional) The specific workflow run ID. Use ${{ github.event.workflow_run.id }} when running in a workflow_run event to download from the triggering run.
• run_number: (Optional) The run number from the workflow.

Reference Criteria (Pick ONE group)

• pr: (Optional) Pull request number.
• commit: (Optional) Commit SHA.
• branch: (Optional) Branch name. Defaults to all branches.
• ref: (Optional) Branch/tag/commit ID. Supersedes branch and commit.
• event: (Optional) The event type (e.g., push).

Artifact Selection

• name: (Optional) The name of the uploaded artifact. If not specified, all artifacts are downloaded and extracted into subdirectories.
• name_is_regexp: (Optional) If true, name is treated as a JavaScript regular expression.
• search_artifacts: (Optional) If true, searches for the last workflow run that stored an artifact matching name. Defaults to false.
• check_artifacts: (Optional) If true, checks if the workflow run has an artifact before attempting download. Defaults to false.

Output and Behavior

• path: (Optional) Directory to extract artifacts into. Defaults to the current directory.
• repo: (Optional) The repository to search in. Defaults to the current repo.
• skip_unpack: (Optional) If true, skips unpacking the downloaded artifact(s). Defaults to false.
• use_unzip: (Optional) If true, uses the unzip system utility to unpack. Defaults to false.
• merge_multiple: (Optional) If true and name_is_regexp is true, multiple found artifacts are merged into one directory. Defaults to false.
• if_no_artifact_found: (Optional) Action exit behavior if no artifact is found. Options: fail (default), warn, ignore.
• allow_forks: (Optional) Includes forks when searching. Defaults to true.

# Example configuration
with:
  github_token: ${{secrets.GITHUB_TOKEN}}
  workflow: main.yml
  workflow_conclusion: success
  name: my-artifact*
  name_is_regexp: true
  path: ./downloads
  if_no_artifact_found: warn