Go to file
Josh Gross f729db2261
Merge pull request #78 from actions/joshmgross/add-code-scanning
Create codeql-analysis.yml
2020-05-11 10:48:04 -04:00
.github Add paths-ignore for md files 2020-05-11 09:48:08 -04:00
__tests__ V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
dist V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
src V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
.eslintignore V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
.eslintrc.json V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
.gitattributes V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
.gitignore V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
.prettierignore V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
.prettierrc.json V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
LICENSE Create LICENSE 2019-07-23 15:25:22 -04:00
README.md V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
action.yml V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
jest.config.js V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
package-lock.json Bump @actions/http-client from 1.0.7 to 1.0.8 (#73) 2020-05-11 12:02:41 +02:00
package.json V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00
tsconfig.json V2 Upload Artifact (#70) 2020-04-28 17:18:53 +02:00

README.md

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)
  • 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/checkout@v2

- run: mkdir -p path/to/artifact

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

- uses: actions/upload-artifact@v2
  with:
    name: my-artifact
    path: path/to/artifact/world.txt

Upload an Entire Directory

- uses: actions/upload-artifact@v2
  with:
    name: my-artifact
    path: path/to/artifact/ # or path/to/artifact

Upload using a Wildcard Pattern:

- uses: actions/upload-artifact@v2
  with:
    name: my-artifact
    path: path/**/[abc]rtifac?/*

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

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 also 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.

Conditional Artifact Upload

To upload artifacts only when the previous step of a job failed, use if: failure():

- uses: actions/upload-artifact@v2
  if: failure()
  with:
    name: my-artifact
    path: path/to/artifact/

Uploading without an artifact name

You can upload an artifact without specifying a name

- uses: actions/upload-artifact@v2
  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/upload-artifact@v2
  with:
    path: world.txt

- run: echo howdy > extra-file.txt
- uses: actions/upload-artifact@v2
  with:
    path: extra-file.txt

- run: echo hello > world.txt
- uses: actions/upload-artifact@v2
  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).

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/upload-artifact@v2
    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/upload-artifact@v2
      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 a 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.

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