Cannot deploy if an environment variable contains a comma

[Kliton]

TL;DR

Commas in environment variables brings to error: google-github-actions/deploy-cloudrun failed with: failed to read file '.env': failed to parse KEY=VALUE pair "example": missing "="

Expected behavior

Escape commas

Observed behavior

Cannot deploy

Action YAML

- name: Deploy to Cloud Run
        id: deploy_cloud_run
        uses: google-github-actions/deploy-cloudrun@v1.0.0
        with:
          service: ${{ env.SERVICE }}
          image: gcr.io/${{ env.PROJECT_ID }}/${{ env.SERVICE }}:${{  github.sha }}
          region: ${{ env.REGION }}
          port: ${{ env.APP_PORT }}
          env_vars_file: .env

Log output

`google-github-actions/deploy-cloudrun failed with: failed to read file '.env': failed to parse KEY=VALUE pair "example": missing "="`

Additional information

No response

[stefafafan]

This portion of the code seems to be responsible, it seems like if you explicitly escape commas yourself like foo\\,bar=value it would work maybe.
https://github.com/google-github-actions/actions-utils/blob/37e11488d71f7f34fbc77fd28ce5f498a26f79dc/src/kv.ts#L44-L51

Looking at the test cases it seems to be intended rather than a bug to parse by commas or newlines unless explictly escaped
https://github.com/google-github-actions/actions-utils/blob/37e11488d71f7f34fbc77fd28ce5f498a26f79dc/tests/kv.test.ts#L32

[sethvargo]

Hi @Kliton, @stefafafan is correct. Since environment variables can be specified as newline separated or comma-separated, you must escape the comma with a \.

[Kliton]

HI, I escaped the comma but is still not working.
Now I have another error:

ERROR: (gcloud.run.deploy) argument --update-env-vars: Bad syntax for dict arg:
The env var is a string long 790 characters.

[ocastx]

Same here – escaped the env var using \, but the variable is still recognized as a dict.

I found the following docs for setting env vars using gcloud commands directly. However, I can't seem to use this, because the env_vars property always delimits using commas. Any idea on how this works using this action? @sethvargo

Example

My current passed env_var: SCOPES=write_product\,write_files\,read_content\,write_customers\,write_draft_orders
which returns argument --update-env-vars: Bad syntax for dict arg: [write_files].

[mikepilat]

@ocastx Just ran into a similar issue myself, and while the ergonomics here are a bit rough, I was able to fix it by doing two things:

1. Escaping the commas as \, in my desired env var value so that they are not interpreted by the env-vars argument for this action
2. Also changing the list delimiter in my env-vars argument for this action, so that the underlying generated --update-env-vars argument to the gcloud run deploy command generated by this action also does not mis-interpret the commas as a dict.

Effectively, in my case:

 - id: prepare_values
   run: |
     echo "value_with_commas=$(cat comma_separated_list.txt | sed -e 's/,/\\,/g' )" >> $GITHUB_ENV
 - id: deploy
   uses: google-github-actions/deploy-cloudrun@v1
   with:
     ...
     env_vars: ^#^MY_VAR=${{ env.value_with_commas }}

Here I'm using # as the list delimiter for gcloud, since it will never appear in my particular list of values. The ^x^ syntax is documented in gcloud help escaping.

Hope that helps!

[gabrielpfl]

I'm having the same problem, is there a way to override the separator in the kvToString function?

export function kvToString(kv: Record<string, string>, separator = ','): string {

When using a list limiter like ^#^:

with:
     ...
     env_vars: |
        ^#^ENV1=VAL1
        ^#^ENV2=VAL2

the generated command is ^#^ENV1=VAL1,^#^ENV2=VAL2