upload-artifact/README.md

47 lines
1.3 KiB
Markdown
Raw Normal View History

2019-06-24 22:38:44 +02:00
# upload-artifact
2019-07-23 21:24:56 +02:00
2019-08-02 20:13:17 +02:00
This uploads artifacts from your workflow.
2019-07-23 21:24:56 +02:00
2019-09-09 07:36:31 +02:00
See also [download-artifact](https://github.com/actions/download-artifact).
2019-07-23 21:24:56 +02:00
# Usage
See [action.yml](action.yml)
2019-07-23 21:35:48 +02:00
Basic:
2019-07-23 21:24:56 +02:00
```yaml
2019-07-26 03:33:03 +02:00
steps:
- uses: actions/checkout@v1
2019-07-23 21:24:56 +02:00
- run: mkdir -p path/to/artifact
- run: echo hello > path/to/artifact/world.txt
2019-11-12 23:29:16 +01:00
- uses: actions/upload-artifact@v1
2019-07-23 21:24:56 +02:00
with:
name: my-artifact
path: path/to/artifact
```
To upload artifacts only when the previous step of a job failed, use [`if: failure()`](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions#job-status-check-functions):
```yaml
2019-11-25 19:12:56 +01:00
- 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<br/>
2020-01-16 20:38:17 +01:00
<img src="https://user-images.githubusercontent.com/16109154/72556687-20235a80-386d-11ea-9e2a-b534faa77083.png" width="375" height="140">
2020-01-16 20:36:06 +01:00
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.
2019-07-23 21:24:56 +02:00
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)