Skip to content

hardis:git:artifacts:download

Description

Command Behavior

Downloads the files a CI job published as artifacts, and lists them.

The validation, deployment and MegaLinter jobs keep their reports as artifacts on the CI server: the complete deployment result, the list of deployed components, the code coverage, the Flow diffs, the linter reports. This command brings them next to your sources, so you can open them like any local file.

  • Job URL: --job-url is the link to the job, as written at the bottom of the Pull Request comment that reports it. Without it, the command asks for it.
  • Where the files go: hardis-report/job-artifacts/<job>/. When the job published several artifacts, each one gets its own sub-folder.
  • Run twice: nothing is downloaded again when the local copy is still the one the server holds. A job run again replaces its artifacts, and the command then replaces the local copy.
  • Expired artifacts: the command says so. Files downloaded before they expired are kept and listed.
  • Providers: GitHub, GitLab and Azure DevOps. Bitbucket has no API to download artifacts: open the job page instead.

The VS Code Pull Request view runs this command behind the Files button of its Validation, Code Quality and Deployment tabs.

Agent Mode

Supports non-interactive execution with --agent:

sf hardis:git:artifacts:download --agent --job-url https://github.com/my-org/my-repo/actions/runs/123456789 --json

In agent mode:

  • --job-url is required: the prompt asking for it is skipped.
  • The result holds status (success, expired, none or unsupported), the absolute folder, the artifacts of the job and the files extracted, each with its path relative to the folder and its size.
Technical explanations
  • The git provider is found from the git remote and its token, like for every command that reads Pull Requests. The token needs to read CI jobs: Actions: Read on GitHub, api or read_api on GitLab, Build: Read on Azure DevOps.
  • The run, job or build id is read from the URL. A URL that is not a job of the current repository is refused, so the token is never used for another repository or sent to another host.
  • GitHub: GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts, then the zip of each artifact that has not expired. GitLab: GET /projects/{id}/jobs/{job_id}, then its artifacts archive. Azure DevOps: the Build API, getArtifacts then the zip of each artifact.
  • Archives are extracted with adm-zip. An entry whose path would leave the target folder is skipped.
  • A .job-artifacts.json manifest in the folder records the artifacts extracted, to skip a download that would bring the same files.

Learn by doing

The free Salesforce DevOps with sfdx-hardis course runs this command, click by click, on an org of your own, in these labs:

Parameters

Name Type Description Default Required Options
agent boolean Run in non-interactive mode for agents and automation
debug
-d		 boolean Activate debug mode (more logs)
flags-dir option Import flag values from a directory.
job-url option URL of the CI job, as written in the Pull Request comment that reports it
json boolean Format output as json.
skipauth boolean Skip authentication check when a default username is required
websocket option Websocket host:port for VsCode SFDX Hardis UI integration

Examples

$ sf hardis:git:artifacts:download

$ sf hardis:git:artifacts:download --job-url https://github.com/my-org/my-repo/actions/runs/123456789

$ sf hardis:git:artifacts:download --agent --job-url https://gitlab.com/my-group/my-project/-/jobs/123456789 --json

Comments