Skip to content

Commit 082fa27

Browse files
authored
Merge pull request #3 from armhil/armhil-updating-readme
Update README.md
2 parents 60bc478 + de46e04 commit 082fa27

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Azure blobs - content uploader
22

3+
[![No real build - some simple tests & executing the action itself](https://github.com/armhil/azure-blobs-content-uploader/actions/workflows/main.yml/badge.svg)](https://github.com/armhil/azure-blobs-content-uploader/actions/workflows/main.yml)
4+
35
Azure Blobs Content Uploader is designed as a github action, to help developers upload their build artifacts to *multiple* az-storage accounts, taking into account the absolute paths / relative paths / recursive structure from your file system.
46

57
It's especially meant to help with SPA developers (ex: artifacts of create-react-app) to quickly upload artifacts to a lot of storage accounts for redundancy and performance.
@@ -8,6 +10,18 @@ It's especially meant to help with SPA developers (ex: artifacts of create-react
810

911
To configure this job, you'll need a few things.
1012

13+
### Your local files
14+
You should decide which directory to upload and to where on the storage accounts. This information is passed as parameters to the `*.yaml` file.
15+
See the `directoriesToUpload` parameter, which supports passing multiple directories. Note that while you can upload multiple directories, **they will be uploaded to the same location**.
16+
17+
```yaml
18+
- name: Upload Static Content
19+
uses: armhil/azure-blobs-content-uploader@1.0.0
20+
with:
21+
azureBlobConfiguration: ${{ secrets.AZ_BLOB_CONFIGURATION }} # could be any secret that you have, see below for the format
22+
directoriesToUpload: '[{"path": "test/integrationtest-directory", "shouldRecurse": "true" }]'
23+
```
24+
1125
### Azure blob details
1226
The content uploader supports uploading to multiple storage accounts, so you're going to need the *connection strings* of all the blob storages that you want to upload the files to.
1327

0 commit comments

Comments
 (0)