upload-artifact

by actions

actions /upload-artifact
634 Stars 114 Forks Last release: 5 months ago (v2) MIT License 61 Commits 11 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Upload-Artifact v2

This uploads artifacts from your workflow allowing you to share data between jobs and store data once a workflow is complete.

See also download-artifact.

What's new

  • Easier upload
    • Specify a wildcard pattern
    • Specify an individual file
    • Specify a directory (previously you were limited to only this option)
    • Multi path upload
    • Use a combination of individual files, wildcards or directories
    • Support for excluding certain files
  • Upload an artifact without providing a name
  • Fix for artifact uploads sometimes not working with containers
  • Proxy support out of the box
  • 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

Upload an Individual File

steps:
- uses: actions/[email protected]

  • run: mkdir -p path/to/artifact

  • run: echo hello > path/to/artifact/world.txt

  • uses: actions/[email protected] with: name: my-artifact path: path/to/artifact/world.txt

Upload an Entire Directory

- uses: actions/[email protected]
with:
  name: my-artifact
  path: path/to/artifact/ # or path/to/artifact

Upload using a Wildcard Pattern

- uses: actions/[email protected]
with:
  name: my-artifact
  path: path/**/[abc]rtifac?/*

Upload using Multiple Paths and Exclusions

- uses: actions/[email protected]
with:
  name: my-artifact
  path: |
    path/output/bin/
    path/output/test-results
    !path/**/*.tmp

For supported wildcards along with behavior and documentation, see @actions/glob which is used internally to search for files.

If a wildcard pattern is used, the path hierarchy will be preserved after the first wildcard pattern.

    path/to/*/directory/foo?.txt =>
        ∟ path/to/some/directory/foo1.txt
        ∟ path/to/some/directory/foo2.txt
        ∟ path/to/other/directory/foo1.txt

would be flattened and uploaded as =>
    ∟ some/directory/foo1.txt
    ∟ some/directory/foo2.txt
    ∟ other/directory/foo1.txt

If multiple paths are provided as input, the least common ancestor of all the search paths will be used as the root directory of the artifact. Exclude paths do not effect the directory structure.

Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory. Paths that begin with a wildcard character should be quoted to avoid being interpreted as YAML aliases.

The @actions/artifact package is used internally to handle most of the logic around uploading an artifact. There is extra documentation around upload limitations and behavior in the toolkit repo that is worth checking out.

Customization if no files are found

If a path (or paths), result in no files being found for the artifact, the action will succeed but print out a warning. In certain scenarios it may be desirable to fail the action or suppress the warning. The

if-no-files-found
option allows you to customize the behavior of the action if no files are found.
- uses: actions/[email protected]
  with:
    name: my-artifact
    path: path/to/artifact/
    if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn` 

Conditional Artifact Upload

To upload artifacts only when the previous step of a job failed, use

if: failure()
:

- uses: actions/[email protected]
  if: failure()
  with:
    name: my-artifact
    path: path/to/artifact/

Uploading without an artifact name

You can upload an artifact without specifying a name

yaml
- uses: actions/[email protected]
  with:
    path: path/to/artifact/world.txt

If not provided,

artifact
will be used as the default name which will manifest itself in the UI after upload.

Uploading to the same artifact

Each artifact behaves as a file share. Uploading to the same artifact multiple times in the same workflow can overwrite and append already uploaded files

- run: echo hi > world.txt
- uses: actions/[email protected]
  with:
    path: world.txt

With the following example, the available artifact (named

artifact
which is the default if no name is provided) would contain both
world.txt
(
hello
) and
extra-file.txt
(
howdy
).

Warning: Be careful when uploading to the same artifact via multiple jobs as artifacts may become corrupted

    strategy:
      matrix:
          node-version: [8.x, 10.x, 12.x, 13.x]
    steps:
        - name: 'Create a file'
          run: echo ${{ matrix.node-version }} > my_file.txt
        - name: 'Accidently upload to the same artifact via multiple jobs'
          uses: 'actions/[email protected]'
          with:
              name: my-artifact
              path: ${{ github.workspace }}

In the above example, four jobs will upload four different files to the same artifact but there will only be one file available when

my-artifact
is downloaded. Each job overwrites what was previously uploaded. To ensure that jobs don't overwrite existing artifacts, use a different name per job.
          uses: 'actions/[email protected]'
          with:
              name: my-artifact ${{ matrix.node-version }}
              path: ${{ github.workspace }}

Environment Variables and Tilde Expansion

You can use

~
in the path input as a substitute for
$HOME
. Basic tilde expansion is supported.
  - run: |  
      mkdir -p ~/new/artifact
      echo hello > ~/new/artifact/world.txt
  - uses: actions/[email protected]
    with:   
      name: 'Artifacts-V2'  
      path: '~/new/**/*'

Environment variables along with context expressions can also be used for input. For documentation see context and expression syntax.

    env:
      name: my-artifact
    steps:
    - run: |    
        mkdir -p ${{ github.workspace }}/artifact
        echo hello > ${{ github.workspace }}/artifact/world.txt
    - uses: actions/[email protected]
      with: 
        name: ${{ env.name }}-name  
        path: ${{ github.workspace }}/artifact/**/*

Where does the upload go?

In the top right corner of a workflow run, once the run is over, if you used this action, there will be an

Artifacts
dropdown which you can download items from. Here's a screenshot of what it looks like

There is a trashcan icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository.

Limitations

Zipped Artifact Downloads

During a workflow run, files are uploaded and downloaded individually using the

upload-artifact
and
download-artifact
actions. However, when a workflow run finishes and an artifact is downloaded from either the UI or through the download api, a zip is dynamically created with all the file contents that were uploaded. There is currently no way to download artifacts after a workflow run finishes in a format other than a zip or to download artifact contents individually. One of the consequences of this limitation is that if a zip is uploaded during a workflow run and then downloaded from the UI, there will be a double zip created.

Permission Loss

:exclamation: File permissions are not maintained during artifact upload :exclamation: For example, if you make a file executable using

chmod
and then upload that file, post-download the file is no longer guaranteed to be set as an executable.

Case Insensitive Uploads

:exclamation: File uploads are case insensitive :exclamation: If you upload

A.txt
and
a.txt
with the same root path, only a single file will be saved and available during download.

Maintaining file permissions and case sensitive files

If file permissions and case sensitivity are required, you can

tar
all of your files together before artifact upload. Post download, the
tar
file will maintain file permissions and case sensitivity.
  - name: 'Tar files'
    run: tar -cvf my_files.tar /path/to/my/directory

  • name: 'Upload Artifact' uses: actions/[email protected] with: name: my-artifact path: my_files.tar

Additional Documentation

See persisting workflow data using artifacts for additional examples and tips.

See extra documentation for the @actions/artifact package that is used internally regarding certain behaviors and limitations.

License

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.