feat: add support for docker_registry option (#331)

Author: sethvargo

action.yaml

@@ -205,6 +205,13 @@ inputs:
       syntax.
     required: false
 
+  docker_registry:
+    description: |-
+      Registry to use for storing Docker containers. This must be one of
+      "artifact-registry" or "container-registry".
+    default: "container-registry"
+    required: false
+
   docker_repository:
     description: |-
       User managed repository created in Artifact Registry.

dist/index.js

@@ -31,8 +31,8 @@
   "author": "Google LLC",
   "license": "Apache-2.0",
   "dependencies": {
-    "@actions/core": "^1.8.0",
-    "@actions/http-client": "^2.0.0",
+    "@actions/core": "^1.8.2",
+    "@actions/http-client": "^2.0.1",
     "@google-github-actions/actions-utils": "^0.3.0",
     "archiver": "^5.3.1",
     "google-auth-library": "^8.0.2",
@@ -42,9 +42,9 @@
     "@types/archiver": "^5.3.1",
     "@types/chai": "^4.3.1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.32",
-    "@typescript-eslint/eslint-plugin": "^5.23.0",
-    "@typescript-eslint/parser": "^5.23.0",
+    "@types/node": "^17.0.35",
+    "@typescript-eslint/eslint-plugin": "^5.25.0",
+    "@typescript-eslint/parser": "^5.25.0",
     "@vercel/ncc": "^0.33.4",
     "chai": "^4.3.6",
     "eslint-config-prettier": "^8.5.0",

package-lock.json

@@ -79,6 +79,7 @@ export type CloudFunction = {
   availableMemoryMb?: number;
   buildEnvironmentVariables?: KVPair;
   buildWorkerPool?: string;
+  dockerRegistry?: string;
   dockerRepository?: string;
   entryPoint?: string;
   environmentVariables?: KVPair;
@@ -382,6 +383,7 @@ export class CloudFunctionsClient {
       'buildEnvironmentVariables',
       'buildWorkerPool',
       'description',
+      'dockerRegistry',
       'dockerRepository',
       'entryPoint',
       'environmentVariables',

package.json

@@ -39,7 +39,7 @@ import {
 
 import { CloudFunction, CloudFunctionsClient, SecretEnvVar, SecretVolume } from './client';
 import { SecretName } from './secret';
-import { formatEntry } from './util';
+import { formatEntry, toEnum } from './util';
 
 async function run(): Promise<void> {
   try {
@@ -77,6 +77,7 @@ async function run(): Promise<void> {
     const secretEnvVars = parseKVString(getInput('secret_environment_variables'));
     const secretVols = parseKVString(getInput('secret_volumes'));
 
+    const dockerRegistry = presence(toEnum(getInput('docker_registry')));
     const dockerRepository = presence(getInput('docker_repository'));
     const kmsKeyName = presence(getInput('kms_key_name'));
 
@@ -191,6 +192,7 @@ async function run(): Promise<void> {
       availableMemoryMb: availableMemoryMb ? +availableMemoryMb : undefined,
       buildEnvironmentVariables: buildEnvironmentVariables,
       buildWorkerPool: buildWorkerPool,
+      dockerRegistry: dockerRegistry,
       dockerRepository: dockerRepository,
       entryPoint: entryPoint,
       environmentVariables: environmentVariables,

src/client.ts

@@ -106,3 +106,15 @@ export function formatEntry(entry: RealEntryData): string {
   const type = (entry.type || 'unknown').toUpperCase()[0];
   return `[${type}] (${mode}) ${name} => ${sourcePath}`;
 }
+
+/**
+ * toEnum converts the input value to the closest enum-string equivalent. It
+ * does this by replacing any dashes or spaces with underscores, and returning
+ * the uppercase result.
+ *
+ * @param s String to enumerize.
+ * @returns string
+ */
+export function toEnum(s: string): string {
+  return (s || '').replace(/[\s-]+/g, '_').toUpperCase();
+}

src/main.ts

@@ -77,6 +77,7 @@ describe('CloudFunctionsClient', () => {
         availableMemoryMb: 512,
         buildEnvironmentVariables: { BUILDKEY1: 'VALUE1', BUILDKEY2: 'VALUE2' },
         // buildWorkerPool: string,
+        dockerRegistry: 'ARTIFACT_REGISTRY',
         // dockerRepository: string,
         entryPoint: 'helloWorld',
         environmentVariables: { KEY1: 'VALUE1', KEY2: 'VALUE2' },
@@ -177,6 +178,7 @@ describe('CloudFunctionsClient', () => {
         availableMemoryMb: 256,
         buildEnvironmentVariables: { BUILDKEY3: 'VALUE3', BUILDKEY4: 'VALUE4' },
         // buildWorkerPool: string,
+        dockerRegistry: 'CONTAINER_REGISTRY',
         // dockerRepository: string,
         entryPoint: 'helloWorld',
         environmentVariables: { KEY3: 'VALUE3', KEY4: 'VALUE4' },

src/util.ts

@@ -6,7 +6,7 @@ import { expect } from 'chai';
 import StreamZip from 'node-stream-zip';
 import { randomFilepath } from '@google-github-actions/actions-utils';
 
-import { zipDir } from '../src/util';
+import { toEnum, zipDir } from '../src/util';
 
 describe('Util', () => {
   describe('#zipDir', () => {
@@ -59,6 +59,52 @@ describe('Util', () => {
       });
     });
   });
+
+  describe('#toEnum', () => {
+    const cases: {
+      name: string;
+      str: string;
+      exp: string;
+    }[] = [
+      {
+        name: 'empty',
+        str: '',
+        exp: '',
+      },
+      {
+        name: 'uppers',
+        str: 'foo',
+        exp: 'FOO',
+      },
+      {
+        name: 'spaces',
+        str: 'foo bar',
+        exp: 'FOO_BAR',
+      },
+      {
+        name: 'dashes',
+        str: 'foo-bar',
+        exp: 'FOO_BAR',
+      },
+      {
+        name: 'multiple spaces',
+        str: 'foo bar   baz',
+        exp: 'FOO_BAR_BAZ',
+      },
+      {
+        name: 'multiple dashes',
+        str: 'foo-bar--baz',
+        exp: 'FOO_BAR_BAZ',
+      },
+    ];
+
+    cases.forEach((tc) => {
+      it(tc.name, () => {
+        const e = toEnum(tc.str);
+        expect(e).to.eql(tc.exp);
+      });
+    });
+  });
 });
 
 /**