Add support for env vars from a file (#413)

- Closes #385 
- Closes #234

Author: sethvargo

.github/workflows/integration.yml

@@ -61,19 +61,20 @@ jobs:
         env_vars: |-
           FOO=bar
           ZIP=zap
+        env_vars_file: './tests/fixtures/env_vars.txt'
         secrets: |-
           MY_SECRET=secret_value:latest
           MY_SECOND_SECRET=new_value:latest
         labels: |-
           label1=value1
           label2=value2
-        flags: "--cpu=2 --concurrency=20"
+        flags: '--cpu=2 --concurrency=20'
 
     - run: 'npm run e2e-tests'
       env:
         PROJECT_ID: ${{ secrets.DEPLOY_CLOUDRUN_PROJECT_ID }}
         SERVICE: '${{ env.SERVICE_NAME }}'
-        ENV: 'FOO=bar,ZIP=zap'
+        ENV: 'FOO=bar,ZIP=zap,TEXT_FOO=bar,TEXT_ZIP=zap'
         SECRET_ENV: MY_SECRET=secret_value:latest,MY_SECOND_SECRET=new_value:latest
         PARAMS: '{"cpu":2, "containerConcurrency":20}'
         LABELS: '{"label1":"value1", "label2":"value2", "commit-sha":"${{ github.sha }}", "managed-by":"github-actions"}'
@@ -94,7 +95,7 @@ jobs:
       env:
         PROJECT_ID: ${{ secrets.DEPLOY_CLOUDRUN_PROJECT_ID }}
         SERVICE: '${{ env.SERVICE_NAME }}'
-        ENV: 'FOO=bar,ZIP=zap,ABC=123,DEF=456'
+        ENV: 'FOO=bar,ZIP=zap,TEXT_FOO=bar,TEXT_ZIP=zap,ABC=123,DEF=456'
         SECRET_ENV: MY_SECRET=secret_value:latest,MY_SECOND_SECRET=new_value:latest
         SECRET_VOLUMES: /api/secrets/my-secret=secret_value:latest
         PARAMS: '{"cpu":2, "containerConcurrency":20}'

README.md

@@ -80,7 +80,9 @@ jobs:
     default value is no suffix.
 
 -   `env_vars`: (Optional) List of key=value pairs to set as environment
-    variables. All existing environment variables will be retained.
+    variables. All existing environment variables will be retained. If both
+    `env_vars` and `env_vars_file` are specified, the keys in env_vars will take
+    precendence over the keys in env_vars_files.
 
     ```yaml
     with:
@@ -89,6 +91,33 @@ jobs:
         ZIP=zap
     ```
 
+-   `env_vars_file`: (Optional) Path to a file on disk, relative to the
+    workspace, that defines environment variables. The file can be
+    newline-separated KEY=VALUE pairs, JSON, or YAML format. If both `env_vars`
+    and `env_vars_file` are specified, the keys in env_vars will take
+    precendence over the keys in env_vars_files.
+
+    ```text
+    FOO=bar
+    ZIP=zap
+    ```
+
+    or
+
+    ```json
+    {
+      "FOO": "bar",
+      "ZIP": "zap"
+    }
+    ```
+
+    or
+
+    ```yaml
+    FOO: 'bar'
+    ZIP: 'zap'
+    ```
+
 -   `secrets`: (Optional) List of key=value pairs to use as secrets. These can
     either be injected as environment variables or mounted as volumes. All
     existing environment secrets and volume mounts will be retained.

action.yml

@@ -40,6 +40,17 @@ inputs:
     description: |-
       List of key-value pairs to set as environment variables in the format:
       KEY1=VALUE1,KEY2=VALUE2. Existing environment variables will be retained.
+      If both "env_vars" and "env_vars_file" are specified, the keys in
+      "env_vars" will take precendence over the keys in "env_vars_files".
+    required: false
+
+  env_vars_file:
+    description: |-
+      Path to a file on disk, relative to the workspace, that defines
+      environment variables. The file can be newline-separated KEY=VALUE pairs,
+      JSON, or YAML format. If both "env_vars" and "env_vars_file" are
+      specified, the keys in "env_vars" will take precendence over the keys in
+      "env_vars_files".
     required: false
 
   secrets:

dist/main/index.js

@@ -32,13 +32,12 @@
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
     "@actions/tool-cache": "^2.0.1",
-    "@google-github-actions/actions-utils": "^0.4.3",
+    "@google-github-actions/actions-utils": "^0.4.4",
     "@google-github-actions/setup-cloud-sdk": "^1.0.1"
   },
   "devDependencies": {
     "@types/chai": "^4.3.4",
     "@types/js-yaml": "^4.0.5",
-    "@types/lodash": "^4.14.190",
     "@types/mocha": "^10.0.1",
     "@types/node": "^18.11.9",
     "@types/sinon": "^10.0.13",
@@ -50,7 +49,6 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",
     "googleapis": "^109.0.1",
-    "lodash": "^4.17.21",
     "mocha": "^10.1.0",
     "prettier": "^2.8.0",
     "sinon": "^15.0.0",

package-lock.json

@@ -33,6 +33,7 @@ import {
   KVPair,
   parseFlags,
   parseKVString,
+  parseKVStringAndFile,
   pinnedToHeadWarning,
   presence,
 } from '@google-github-actions/actions-utils';
@@ -86,7 +87,8 @@ export async function run(): Promise<void> {
     const projectId = getInput('project_id');
     const gcloudVersion = await computeGcloudVersion(getInput('gcloud_version'));
     const gcloudComponent = presence(getInput('gcloud_component')); // Cloud SDK component version
-    const envVars = parseKVString(getInput('env_vars')); // String of env vars KEY=VALUE,...
+    const envVars = getInput('env_vars'); // String of env vars KEY=VALUE,...
+    const envVarsFile = getInput('env_vars_file'); // File that is a string of env vars KEY=VALUE,...
     const secrets = parseKVString(getInput('secrets')); // String of secrets KEY=VALUE,...
     const region = getInput('region') || 'us-central1';
     const source = getInput('source'); // Source directory
@@ -132,7 +134,7 @@ export async function run(): Promise<void> {
         image: image !== '',
         metadata: metadata !== '',
         source: source !== '',
-        env_vars: Object.keys(envVars).length > 0,
+        env_vars: envVars !== '',
         no_traffic: noTraffic,
         secrets: Object.keys(secrets).length > 0,
         suffix: suffix !== '',
@@ -152,7 +154,7 @@ export async function run(): Promise<void> {
         image: image !== '',
         service: service !== '',
         source: source !== '',
-        env_vars: Object.keys(envVars).length > 0,
+        env_vars: envVars !== '',
         no_traffic: noTraffic,
         secrets: Object.keys(secrets).length > 0,
         suffix: suffix !== '',
@@ -179,8 +181,9 @@ export async function run(): Promise<void> {
       }
 
       // Set optional flags from inputs
-      if (envVars && Object.keys(envVars).length > 0) {
-        cmd.push('--update-env-vars', kvToString(envVars));
+      const compiledEnvVars = parseKVStringAndFile(envVars, envVarsFile);
+      if (compiledEnvVars && Object.keys(compiledEnvVars).length > 0) {
+        cmd.push('--update-env-vars', kvToString(compiledEnvVars));
       }
       if (secrets && Object.keys(secrets).length > 0) {
         cmd.push('--update-secrets', kvToString(secrets));