Add support for build_environment_variables (#210)

Author: sethvargo

.github/workflows/integration.yml

@@ -220,6 +220,8 @@ jobs:
         event_trigger_type: 'providers/cloud.pubsub/eventTypes/topic.publish'
         event_trigger_resource: '${{ secrets.DEPLOY_CF_EVENT_PUBSUB_TOPIC }}'
         env_vars_file: './tests/env-var-files/test.good.yaml'
+        build_environment_variables: 'FOO=bar, ZIP=zap'
+        build_environment_variables_file: './tests/env-var-files/test.good.yaml'
 
     # Auth as the main account for integration and cleanup
     - uses: 'google-github-actions/auth@main'

README.md

@@ -95,6 +95,13 @@ steps:
 
 - `deploy_timeout`: (Optional) The function deployment timeout in seconds. Defaults to 300.
 
+- `build_environment_variables`: (Optional) List of environment variables that
+  should be available while the function is built. Note this is different than
+  runtime environment variables, which should be set with 'env_vars'.
+
+- `build_environment_variables_file`: (Optional) Path to a local YAML file
+  containing variables. See 'env_vars_file' for syntax.
+
 - `credentials`: (**Deprecated**) This input is deprecated. See [auth section](https://github.com/google-github-actions/deploy-cloud-functions#via-google-github-actionsauth) for more details.
   Service account key to use for authentication. This should be
   the JSON formatted private key which can be exported from the Cloud Console. The

action.yaml

@@ -134,6 +134,19 @@ inputs:
     default: 300
     required: false
 
+  build_environment_variables:
+    description: |-
+      Optional list of environment variables that should be available while the
+      function is built. Note this is different than runtime environment
+      variables, which should be set with 'env_vars'.
+    required: false
+
+  build_environment_variables_file:
+    description: |-
+      Path to a local YAML file containing variables. See 'env_vars_file' for
+      syntax.
+    required: false
+
 outputs:
   url:
     description: The URL of your Cloud Function. Only available with HTTP Trigger.

dist/index.js

@@ -62,6 +62,11 @@ async function run(): Promise<void> {
     const deployTimeout = presence(getInput('deploy_timeout'));
     const labels = parseKVString(getInput('labels'));
 
+    const buildEnvVars = presence(getInput('build_environment_variables'));
+    const buildEnvVarsFile = presence(
+      getInput('build_environment_variables_file'),
+    );
+
     // Add warning if using credentials
     let credentialsJSON:
       | ServiceAccountKey
@@ -102,6 +107,10 @@ async function run(): Promise<void> {
       credentials: credentialsJSON,
     });
 
+    const buildEnvironmentVariables = parseKVStringAndFile(
+      buildEnvVars,
+      buildEnvVarsFile,
+    );
     const environmentVariables = parseKVStringAndFile(envVars, envVarsFile);
 
     // Create Function definition
@@ -110,7 +119,7 @@ async function run(): Promise<void> {
       runtime: runtime,
       description: description,
       availableMemoryMb: availableMemoryMb ? +availableMemoryMb : undefined,
-      // buildEnvironmentVariables: buildEnvironmentVariables, // TODO: add support
+      buildEnvironmentVariables: buildEnvironmentVariables,
       // buildWorkerPool: buildWorkerPool, // TODO: add support
       // dockerRepository: dockerRepository, // TODO: add support
       entryPoint: entryPoint,

src/main.ts

@@ -74,6 +74,7 @@ describe('CloudFunctionsClient', () => {
         name: testFunctionName,
         runtime: 'nodejs12',
         environmentVariables: { KEY1: 'VALUE1' },
+        buildEnvironmentVariables: { KEY1: 'VALUE1' },
         entryPoint: 'helloWorld',
         availableMemoryMb: 512,
         sourceUploadUrl: sourceURL,