Download-Artifact v2

This downloads artifacts from your build

What's new

Download all artifacts at once
Port entire action to typescript from a runner plugin so it is easier to collaborate and accept contributions

Refer here for the previous version

Usage

See action.yml

Download a Single Artifact

Basic (download to the current working directory):

steps:
- uses: actions/checkout@v2

- uses: actions/download-artifact@v2
  with:
    name: my-artifact
    
- name: Display structure of downloaded files
  run: ls -R

Download to a specific directory:

steps:
- uses: actions/checkout@v2

- uses: actions/download-artifact@v2
  with:
    name: my-artifact
    path: path/to/artifact
    
- name: Display structure of downloaded files
  run: ls -R
  working-directory: path/to/artifact

Download an artifact and create an extra directory

steps:
- uses: actions/checkout@v2

- uses: actions/download-artifact@v2
  with:
    name: my-artifact
    path: path/to/artifact
    artifact-folder: true
    
- name: Display structure of downloaded files
  run: ls -R
  working-directory: path/to/artifact

If artifact-folder is set to true. An extra directory denoted by the name of the artifact will be created

   path/to/artifact/
      my-artifact/
          ... contents of my-artifact

If artifact-folder is set to false (the default), there will be no extra folder created

   path/to/artifact/
      ... contents of my-artifact

Download All Artifacts

If the name input parameter is not provided, all artifacts will be downloaded. To differentiate between downloaded artifacts, a directory denoted by the artifacts name will be created for each individual artifact. Currently the artifact-folder input-parameter is not respected when downloading all artifacts.

Example, if there are two artifacts Artifact-A and Artifact-B, and the directory is etc/usr/artifacts/, the directory structure will look like this:

  etc/usr/artifacts/
      Artifact-A/
          ... contents of Artifact-A
      Artifact-B/
          ... contents of Artifact-B

Download all artifacts to a specific directory

steps:
- uses: actions/checkout@v2

- uses: actions/download-artifact@v2
  with:
    path: path/to/artifacts
    
- name: Display structure of downloaded files
  run: ls -R
  working-directory: path/to/artifacts

Download all artifacts to the current working directory

steps:
- uses: actions/checkout@v2

- uses: actions/download-artifact@v2

- name: Display structure of downloaded files
  run: ls -R

@actions/artifact package

Internally the @actions/artifact NPM package is used to interact with artifacts. You can find additional documentation there along with all the source code related to artifact download.

License

The scripts and documentation in this project are released under the MIT License

3.1 KiB Raw Blame History