Skip to content

Update README.md headers settable field casing#312

Merged
sethvargo merged 1 commit into
google-github-actions:mainfrom
robertvanhoesel:patch-1
Mar 2, 2023
Merged

Update README.md headers settable field casing#312
sethvargo merged 1 commit into
google-github-actions:mainfrom
robertvanhoesel:patch-1

Conversation

@robertvanhoesel

Copy link
Copy Markdown
Contributor

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>
@robertvanhoesel robertvanhoesel requested a review from a team as a code owner March 2, 2023 14:41
@google-cla

google-cla Bot commented Mar 2, 2023

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@sethvargo sethvargo merged commit d1df263 into google-github-actions:main Mar 2, 2023
sethvargo pushed a commit that referenced this pull request Mar 30, 2023
## What's Changed
* Clean up unit and integration tests, remove labeler by @sethvargo in
#305
* Update CI and deps by @sethvargo in
#306
* Drop unused configPath field by @sethvargo in
#307
* Update README.md headers settable field casing by @robertvanhoesel in
#312
* chore: update dependencies (automated) by @verbanicm in
#315
* Print warnings when a gcloudignore is not found by @sethvargo in
#313
* Switch to pull non-secret values from env by @sethvargo in
#316
* Update deps by @sethvargo in
#318

## New Contributors
* @robertvanhoesel made their first contribution in
#312

**Full Changelog**:
v1.0.0...7a972d4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants