Skip to content

Commit 987cd6c

Browse files
authored
Update README.md
Improve docs
1 parent 9c57d4b commit 987cd6c

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,30 @@ See the `directoriesToUpload` parameter, which supports passing multiple directo
2525
- name: Upload Static Content
2626
uses: armhil/azure-blobs-content-uploader@1.0.9
2727
with:
28+
# required parameter - your entra (ex: AAD) - application id
2829
clientId: ${{ secrets.ENTRA_CLIENTID }}
30+
31+
# required parameter - your entra (ex: AAD) - application secret
2932
clientSecret: ${{ secrets.ENTRA_CLIENTSECRET }}
33+
34+
# required parameter - your entra (ex: AAD) - tenant id
3035
tenantId: ${{ secrets.ENTRA_TENANTID }}
31-
storageAccountList: ${{ secrets.STORAGE_ACCOUNT_LIST }} # Storage account names, in array form like ["account1", "account2"]
36+
37+
# required parameter - storage account names that you're uploading to.
38+
# if you're providing this value from secrets, use just the array form like ["account1", "account2"]
39+
# if you're passing this value from the yaml file (so directly adding to source) - use quotations like so: '["account1", "account2"]'
40+
storageAccountList: ${{ secrets.STORAGE_ACCOUNT_LIST }}
41+
42+
# required parameter - container name, same across all storage accounts, $web is recommended if you're hosting SPAs - see here:
43+
# https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website
3244
containerName: "$web"
45+
46+
# required parameter - what are you uploading, whether recursively or not. If you want to map the artifacts to a particular location in the container
47+
# you can use the "baseContainerPath" property of each record.
48+
# see an example here: https://github.com/armhil/easy-qrcode-barcode-addin/blob/main/.github/workflows/main.yml
3349
directoriesToUpload: '[{"directoryToUpload": "test/integrationtest-directory", "shouldRecurse": "true" }]'
34-
```
3550

36-
*Hint*: If you're uploading some static content for web-apps (like artifacts of create-react-app) - you can use the `$web` container from Azure Blob Storage.
51+
# optional parameter - what file extensions with content-type are you uploading? Others will be omitted.
52+
# default value: '{ ".html": "text/html", ".pdf": "application/pdf", ".png": "image/png", ".jpg": "image/jpeg", ".svg": "image/svg+xml", ".css": "text/css", ".js": "application/x-javascript" }'
53+
fileTypesToUpload: '{ ".html": "text/html" }'
54+
```

0 commit comments

Comments
 (0)