Skip to content

Commit d1df263

Browse files
Update README.md headers settable field casing (#312)
It is a bit of a gotcha that the `headers` settable fields are the lowercase counterparts to their Header. The docs incorrectly mention the case sensitive varitions, which when followed causes an error: ``` - uses: google-github-actions/upload-cloud-storage@v1 with: path: /foo destination: bucket headers: |- Cache-Control: public, max-age=31536000, no-transform, immutable google-github-actions/upload-cloud-storage failed with: invalid header key "Cache-Control" - custom header keys must be prefixed with "x-goog-meta-" ``` For future users and clarity, I think it is best to update the documentation to use the fully lowercase versions. Signed-off-by: Robert van Hoesel <robertvanhoesel@gmail.com>
1 parent ac231a9 commit d1df263

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,8 @@ If `parent` is set to `false`, it wil be uploaded to `gs://bucket-name/folder2/f
241241
and custom metadata with key `custom-field` and value `custom-value` will be
242242
added to it.
243243

244-
Settable fields are: `Cache-Control`, `Content-Disposition`,
245-
`Content-Encoding`, `Content-Language`, `Content-Type`, `Custom-Time`. See
244+
Settable fields are: `cache-control`, `content-disposition`,
245+
`content-encoding`, `content-language`, `content-type`, `custom-time`. See
246246
[the
247247
document](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata#settable-fields;-field-values)
248248
for details.

0 commit comments

Comments
 (0)