Braxton Beyer d8c2e06943
adding comments to readme
adding more comments to readme to better explain how this works.
2020-01-22 21:25:09 -05:00
2020-01-22 21:20:58 -05:00
2019-07-23 15:25:22 -04:00
2020-01-22 21:25:09 -05:00

upload-artifact

This uploads artifacts from your workflow.

See also download-artifact.

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@v1

- run: mkdir -p path/to/artifact

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

- uses: actions/upload-artifact@v1
  with:
    # A directory will be created with this name and populated with the items in the path below.
    # Then it will be compressed into a zip file.
    # if you later use download-artifact, this zip file will be downloaded and automatically expanded.
    name: my-artifact
    path: path/to/artifact

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

- uses: actions/upload-artifact@v1
  if: failure()
  with:
    name: my-artifact
    path: path/to/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 trash can icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository.

License

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

Languages
TypeScript 99.3%
JavaScript 0.7%