Remove features that were upstreamed into actions-utils (#412)

Author: sethvargo

bin/docs.mjs

@@ -5,7 +5,7 @@
   "main": "dist/index.js",
   "scripts": {
     "build": "ncc build -m src/main.ts",
-    "docs": "node ./bin/docs.mjs",
+    "docs": "./node_modules/.bin/actions-gen-readme",
     "lint": "eslint . --ext .ts,.tsx",
     "format": "prettier --write **/*.ts",
     "test": "node --require ts-node/register --test-reporter spec --test tests/client.test.ts tests/secret.test.ts tests/util.test.ts"
@@ -31,7 +31,7 @@
   "dependencies": {
     "@actions/core": "^1.10.1",
     "@actions/http-client": "^2.2.1",
-    "@google-github-actions/actions-utils": "^0.7.6",
+    "@google-github-actions/actions-utils": "^0.8.0",
     "archiver": "^7.0.1",
     "google-auth-library": "^9.10.0",
     "ignore": "^5.3.1"

package-lock.json

@@ -20,7 +20,9 @@ import {
   errorMessage,
   parseBoolean,
   parseDuration,
+  parseKVString,
   presence,
+  toEnum,
 } from '@google-github-actions/actions-utils';
 
 import {
@@ -31,7 +33,7 @@ import {
   RetryPolicy,
   VpcConnectorEgressSettings,
 } from './client';
-import { formatEntry, parseKVWithEmpty, parseSecrets, stringToInt, toEnum } from './util';
+import { formatEntry, parseSecrets, stringToInt } from './util';
 
 async function run() {
   try {
@@ -45,12 +47,12 @@ async function run() {
     const description = presence(getInput('description'));
     const environment = toEnum(Environment, getInput('environment') || Environment.GEN_2);
     const kmsKeyName = presence(getInput('kms_key_name'));
-    const labels = parseKVWithEmpty(getInput('labels'));
+    const labels = parseKVString(getInput('labels'));
     const sourceDir = presence(getInput('source_dir')) || process.cwd();
 
     // buildConfig
     const runtime = getInput('runtime', { required: true });
-    const buildEnvironmentVariables = parseKVWithEmpty(getInput('build_environment_variables'));
+    const buildEnvironmentVariables = parseKVString(getInput('build_environment_variables'));
     const buildServiceAccount = presence(getInput('build_service_account'));
     const buildWorkerPool = presence(getInput('build_worker_pool'));
     const dockerRepository = presence(getInput('docker_repository'));
@@ -63,7 +65,7 @@ async function run() {
     );
     const availableCpu = presence(getInput('available_cpu'));
     const availableMemory = presence(getInput('memory')) || '256Mi';
-    const environmentVariables = parseKVWithEmpty(getInput('environment_variables'));
+    const environmentVariables = parseKVString(getInput('environment_variables'));
     const ingressSettings = toEnum(
       IngressSettings,
       getInput('ingress_settings') || IngressSettings.ALLOW_ALL,

package.json

@@ -20,10 +20,8 @@ import * as path from 'path';
 
 import * as Archiver from 'archiver';
 import {
-  KVPair,
   parseGcloudIgnore,
   parseKVString,
-  presence,
   toPlatformPath,
 } from '@google-github-actions/actions-utils';
 import ignore from 'ignore';
@@ -130,28 +128,6 @@ export function formatEntry(entry: RealEntryData): string {
   return `[${type}] (${mode}) ${name} => ${sourcePath}`;
 }
 
-/**
- * toEnum converts the input value to the best enum value. If no enum value
- * exists, it throws an error.
- *
- * @param e Enum to check against.
- * @param s String to enumerize.
- * @returns string
- */
-export function toEnum<E extends Record<string, string>>(e: E, s: string): E[keyof E] {
-  const originalValue = (s || '').toUpperCase();
-  const mutatedValue = originalValue.replace(/[\s-]+/g, '_');
-
-  if (originalValue in e) {
-    return e[originalValue] as E[keyof E];
-  } else if (mutatedValue in e) {
-    return e[mutatedValue] as E[keyof E];
-  } else {
-    const keys = Object.keys(e) as Array<keyof E>;
-    throw new Error(`Invalid value ${s}, valid values are ${JSON.stringify(keys)}`);
-  }
-}
-
 /**
  * stringToInt is a helper that converts the given string into an integer. If
  * the given string is empty, it returns undefined. If the string is not empty
@@ -173,26 +149,14 @@ export function stringToInt(str: string): number | undefined {
   }
   return result;
 }
-
-/**
- * parseKVWithEmpty parses the given string as a KEY=VALUE string and the given
- * file as a KV file. As a special case, if the given string is the literal
- * "{}", it returns the empty object. This allows callers to explicitly remove
- * all environment variables.
- */
-export function parseKVWithEmpty(s: string): KVPair | undefined {
-  const sp = presence(s) === '{}' ? '' : presence(s);
-  if (sp !== undefined) return parseKVString(sp);
-}
-
 /**
  * parseSecrets parses the input as environment variable and volume mounted
  * secrets.
  */
 export function parseSecrets(
   val: string,
 ): [SecretEnvVar[] | undefined, SecretVolume[] | undefined] {
-  const kv = parseKVWithEmpty(val);
+  const kv = parseKVString(val);
   if (kv === undefined) {
     return [undefined, undefined];
   }

src/main.ts

@@ -20,29 +20,7 @@ import assert from 'node:assert';
 import StreamZip from 'node-stream-zip';
 import { assertMembers, randomFilepath } from '@google-github-actions/actions-utils';
 
-import { parseKVWithEmpty, stringToInt, zipDir } from '../src/util';
-
-test('#parseKVWithEmpty', { concurrency: true }, async (suite) => {
-  const cases = [
-    {
-      name: 'both empty',
-      s: '',
-      expected: undefined,
-    },
-    {
-      name: 'braces {}',
-      s: '{}',
-      expected: {},
-    },
-  ];
-
-  for await (const tc of cases) {
-    await suite.test(tc.name, async () => {
-      const actual = parseKVWithEmpty(tc.s);
-      assert.deepStrictEqual(actual, tc.expected);
-    });
-  }
-});
+import { stringToInt, zipDir } from '../src/util';
 
 test('#zipDir', { concurrency: true }, async (suite) => {
   const cases = [