Generate separate TS file with version mappings

Author: mbg

pr-checks/sync_back.test.ts

@@ -13,14 +13,14 @@ import { afterEach, beforeEach, describe, it } from "node:test";
 import {
   Options,
   scanGeneratedWorkflows,
-  updateSyncTs,
+  updateActionVersions,
   updateTemplateFiles,
 } from "./sync_back";
 
 let testDir: string;
 let workflowDir: string;
 let checksDir: string;
-let syncTsPath: string;
+let actionVersionsTsPath: string;
 
 const defaultOptions: Options = { verbose: false, force: false };
 
@@ -32,8 +32,8 @@ beforeEach(() => {
   fs.mkdirSync(workflowDir, { recursive: true });
   fs.mkdirSync(checksDir, { recursive: true });
 
-  // Create sync.ts file path
-  syncTsPath = path.join(testDir, "pr-checks", "sync.ts");
+  // Create action-versions.ts file path
+  actionVersionsTsPath = path.join(testDir, "pr-checks", "action-versions.ts");
 });
 
 afterEach(() => {
@@ -130,83 +130,67 @@ jobs:
   });
 });
 
-describe("updateSyncTs", () => {
-  it("updates sync.ts file", () => {
-    /** Test updating sync.ts file */
-    const syncTsContent = `
-const steps = [
-  {
-    uses: "actions/setup-node@v4",
-    with: { "node-version": "16" },
+describe("updateActionVersions", () => {
+  it("updates action-versions.ts file", () => {
+    /** Test updating action-versions.ts file */
+    const actionVersionsTsContent = `
+export const ACTION_VERSIONS = {
+  "actions/setup-node": {
+    "version": "v4"
   },
-  {
-    uses: "actions/setup-go@v5",
-    with: { "go-version": "1.19" },
-  },
-];
-`;
+  "actions/setup-go": {
+    "version": "v5"
+  }
+};
+`.trim();
 
-    fs.writeFileSync(syncTsPath, syncTsContent);
+    fs.writeFileSync(actionVersionsTsPath, actionVersionsTsContent);
 
     const actionVersions = {
       "actions/setup-node": { version: "v5" },
       "actions/setup-go": { version: "v6" },
     };
 
-    const result = updateSyncTs(defaultOptions, syncTsPath, actionVersions);
-    assert.equal(result, true);
-
-    const updatedContent = fs.readFileSync(syncTsPath, "utf8");
-
-    assert.ok(updatedContent.includes('uses: "actions/setup-node@v5"'));
-    assert.ok(updatedContent.includes('uses: "actions/setup-go@v6"'));
-  });
-
-  it("strips comments from versions", () => {
-    /** Test updating sync.ts file when versions have comments */
-    const syncTsContent = `
-const steps = [
-  {
-    uses: "actions/setup-node@v4",
-    with: { "node-version": "16" },
-  },
-];
-`;
-
-    fs.writeFileSync(syncTsPath, syncTsContent);
-
-    const actionVersions = {
-      "actions/setup-node": { version: "v5", comment: " Latest version" },
-    };
-
-    const result = updateSyncTs(defaultOptions, syncTsPath, actionVersions);
+    const result = updateActionVersions(
+      defaultOptions,
+      actionVersionsTsPath,
+      actionVersions,
+    );
     assert.equal(result, true);
 
-    const updatedContent = fs.readFileSync(syncTsPath, "utf8");
+    const updatedContent = fs.readFileSync(actionVersionsTsPath, "utf8");
 
-    // sync.ts should get the version without comment
-    assert.ok(updatedContent.includes('uses: "actions/setup-node@v5"'));
-    assert.ok(!updatedContent.includes("# Latest version"));
+    assert.ok(
+      updatedContent.includes('"actions/setup-node": {\n    "version": "v5"'),
+    );
+    assert.ok(
+      updatedContent.includes('"actions/setup-go": {\n    "version": "v6"'),
+    );
   });
 
   it("returns false when no changes are needed", () => {
-    /** Test that updateSyncTs returns false when no changes are needed */
-    const syncTsContent = `
-const steps = [
-  {
-    uses: "actions/setup-node@v5",
-    with: { "node-version": "16" },
-  },
-];
-`;
+    /** Test that updateActionVersions returns false when no changes are needed */
+    const actionVersionsTsContent = `
+export const ACTION_VERSIONS = {
+  "actions/setup-node": {
+    "version": "v5"
+  }
+};
+`.trim();
 
-    fs.writeFileSync(syncTsPath, syncTsContent);
+    fs.writeFileSync(actionVersionsTsPath, actionVersionsTsContent);
 
     const actionVersions = {
       "actions/setup-node": { version: "v5" },
     };
 
-    const result = updateSyncTs(defaultOptions, syncTsPath, actionVersions);
+    const result = updateActionVersions(
+      defaultOptions,
+      actionVersionsTsPath,
+      actionVersions,
+    );
+    const updatedContent = fs.readFileSync(actionVersionsTsPath, "utf8");
+    assert.equal(updatedContent, actionVersionsTsContent);
     assert.equal(result, false);
   });
 });

pr-checks/sync_back.ts

@@ -27,7 +27,7 @@ import * as path from "path";
 const THIS_DIR = __dirname;
 const CHECKS_DIR = path.join(THIS_DIR, "checks");
 const WORKFLOW_DIR = path.join(THIS_DIR, "..", ".github", "workflows");
-const SYNC_TS_PATH = path.join(THIS_DIR, "sync.ts");
+const ACTION_VERSIONS_PATH = path.join(THIS_DIR, "action-versions.ts");
 
 /** Command-line options for this program. */
 export type Options = {
@@ -126,46 +126,34 @@ export function scanGeneratedWorkflows(
 }
 
 /**
- * Update hardcoded action versions in pr-checks/sync.ts
+ * Update hardcoded action versions in pr-checks/action-versions.ts
  *
  * @param options - The command-line options.
- * @param syncTsPath - Path to sync.ts file
+ * @param actionVersionsTsPath - Path to action-versions.ts file
  * @param actionVersions - Map of action names to versions (may include comments)
  * @returns True if the file was modified, false otherwise
  */
-export function updateSyncTs(
+export function updateActionVersions(
   options: Options,
-  syncTsPath: string,
+  actionVersionsTsPath: string,
   actionVersions: Record<string, ActionVersion>,
 ): boolean {
-  if (!fs.existsSync(syncTsPath)) {
-    throw new Error(`Could not find ${syncTsPath}`);
-  }
+  // Build content for the file.
+  let newContent: string = `export const ACTION_VERSIONS = ${JSON.stringify(actionVersions, null, 2)};`;
 
-  let content = fs.readFileSync(syncTsPath, "utf8");
-  const originalContent = content;
+  if (fs.existsSync(actionVersionsTsPath)) {
+    const content = fs.readFileSync(actionVersionsTsPath, "utf8");
 
-  // Update hardcoded action versions
-  for (const [actionName, versionInfo] of Object.entries(actionVersions)) {
-    // Note that this will break if we store an Action uses reference in a
-    // variable - that's a risk we're happy to take since in that case the
-    // PR checks will just fail.
-    const escaped = actionName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-    const pattern = new RegExp(`(uses:\\s*")${escaped}@(?:[^"]+)(")`, "g");
-    content = content.replace(
-      pattern,
-      `$1${actionName}@${versionInfo.version}$2`,
-    );
+    if (content === newContent && !options.force) {
+      console.info(`No changes needed in ${actionVersionsTsPath}`);
+      return false;
+    }
   }
 
-  if (content !== originalContent || options.force) {
-    fs.writeFileSync(syncTsPath, content, "utf8");
-    console.info(`Updated ${syncTsPath}`);
-    return true;
-  } else {
-    console.info(`No changes needed in ${syncTsPath}`);
-    return false;
-  }
+  // Update hardcoded action versions
+  fs.writeFileSync(actionVersionsTsPath, newContent, "utf8");
+  console.info(`Updated ${actionVersionsTsPath}`);
+  return true;
 }
 
 /**
@@ -263,8 +251,8 @@ function main(): number {
   const modifiedFiles: string[] = [];
 
   // Update sync.ts
-  if (updateSyncTs(values, SYNC_TS_PATH, actionVersions)) {
-    modifiedFiles.push(SYNC_TS_PATH);
+  if (updateActionVersions(values, ACTION_VERSIONS_PATH, actionVersions)) {
+    modifiedFiles.push(ACTION_VERSIONS_PATH);
   }
 
   // Update template files