Skip to content

Commit c8d28b6

Browse files
committed
Update README
1 parent 4e55e87 commit c8d28b6

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# azblob-upload-artifact
22

3+
![Test](https://github.com/fixpoint/azblob-upload-artifact/workflows/Test/badge.svg)
4+
35
This upload artifacts from your workflow to [Azure Blob Storage](https://azure.microsoft.com/ja-jp/services/storage/blobs/).
6+
It follows usage of [actions/upload-artifact](https://github.com/actions/upload-artifact) for easy migration.
47

58
See also [azblob-download-artifact](https://github.com/fixpoint/azblob-download-artifact).
69

710
## Usage
811

9-
Get [Azure Storage connection strings](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string) and save it into secrets.
10-
11-
See [action.yml](./action.yml)
12-
13-
Basic:
12+
Get [Azure Storage connection strings](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string) and specify it to `connection-string` through Github secrets like:
1413

1514
```yaml
1615
steps:
@@ -20,13 +19,26 @@ steps:
2019

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

23-
- uses: fixpoint/azblob-upload-artifact@master
22+
- uses: fixpoint/azblob-upload-artifact@v1
2423
with:
2524
connection-string: ${{ secrets.AZURE_STORAGE_CONNECTION_STRING }}
2625
name: my-artifact
2726
path: path/to/artifact
2827
```
2928
29+
To upload artifacts only when the previous step of a job failed, use `if: failure()`:
30+
31+
```yaml
32+
- uses: fixpoint/azblob-upload-artifact@v1
33+
if: failure()
34+
with:
35+
connection-string: ${{ secrets.AZURE_STORAGE_CONNECTION_STRING }}
36+
name: my-artifact
37+
path: path/to/artifact
38+
```
39+
40+
See [action.yml](./action.yml) for more detail.
41+
3042
## License
3143

3244
This scripts and documentation in this project are released under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)