Add script and workflow to sync the set of starter-workflows for GHES

2020-05-15 16:49:20 -07:00
parent e3d245e1f3
commit 5802cb7302
9 changed files with 390 additions and 0 deletions
@@ -0,0 +1,26 @@
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - run: |
+        git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
+        git config user.email "cschleiden@github.com"
+        git config user.name "GitHub Actions"
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12'
+    - name: Check starter workflows for GHES compat
+      run: |
+        npm ci
+        npx ts-node-script ./index.ts
+      working-directory: ./script
+    - run: |
+        git add -A
+        git commit -m "Updating GHES workflows"
+    - run: git push
@@ -0,0 +1 @@
+script/node_modules
@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "args": ["${workspaceRoot}/script/index.ts"],
+      "runtimeArgs": ["-r", "ts-node/register"],
+      "cwd": "${workspaceRoot}/script",
+			"protocol": "inspector",
+			"internalConsoleOptions": "openOnSessionStart",
+			"env": {
+				"TS_NODE_IGNORE": "false"
+			}
+    }
+  ]
+}
@@ -0,0 +1,42 @@
+import { spawn } from "child_process";
+
+export class ExecResult {
+  stdout = "";
+  exitCode = 0;
+}
+
+/**
+ * Executes a process
+ */
+export async function exec(
+  command: string,
+  args: string[] = [],
+  allowAllExitCodes: boolean = false
+): Promise<ExecResult> {
+  process.stdout.write(`EXEC: ${command} ${args.join(" ")}\n`);
+  return new Promise((resolve, reject) => {
+    const execResult = new ExecResult();
+    const cp = spawn(command, args, {});
+
+    // STDOUT
+    cp.stdout.on("data", (data) => {
+      process.stdout.write(data);
+      execResult.stdout += data.toString();
+    });
+
+    // STDERR
+    cp.stderr.on("data", (data) => {
+      process.stderr.write(data);
+    });
+
+    // Close
+    cp.on("close", (code) => {
+      execResult.exitCode = code;
+      if (code === 0 || allowAllExitCodes) {
+        resolve(execResult);
+      } else {
+        reject(new Error(`Command exited with code ${code}`));
+      }
+    });
+  });
+}
@@ -0,0 +1,144 @@
+#!/usr/bin/env npx ts-node
+import { promises as fs } from "fs";
+import { safeLoad } from "js-yaml";
+import { basename, extname, join } from "path";
+import { exec } from "./exec";
+
+interface WorkflowDesc {
+  folder: string;
+  id: string;
+}
+
+interface WorkflowsCheckResult {
+  compatibleWorkflows: WorkflowDesc[];
+  incompatibleWorkflows: WorkflowDesc[];
+}
+
+async function checkWorkflows(
+  folders: string[],
+  enabledActions: string[]
+): Promise<WorkflowsCheckResult> {
+  const result: WorkflowsCheckResult = {
+    compatibleWorkflows: [],
+    incompatibleWorkflows: [],
+  };
+
+  for (const folder of folders) {
+    const dir = await fs.readdir(folder, {
+      withFileTypes: true,
+    });
+
+    for (const e of dir) {
+      if (e.isFile()) {
+        const workflowFilePath = join(folder, e.name);
+        const enabled = await checkWorkflow(workflowFilePath, enabledActions);
+
+        const workflowDesc: WorkflowDesc = {
+          folder,
+          id: basename(e.name, extname(e.name)),
+        };
+
+        if (!enabled) {
+          result.incompatibleWorkflows.push(workflowDesc);
+        } else {
+          result.compatibleWorkflows.push(workflowDesc);
+        }
+      }
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Check if a workflow only the given set of actions.
+ *
+ * @param workflowPath Path to workflow yaml file
+ * @param enabledActions List of enabled actions
+ */
+async function checkWorkflow(
+  workflowPath: string,
+  enabledActions: string[]
+): Promise<boolean> {
+  // Create set with lowercase action names for easier, case-insensitive lookup
+  const enabledActionsSet = new Set(enabledActions.map((x) => x.toLowerCase()));
+
+  try {
+    const workflowFileContent = await fs.readFile(workflowPath, "utf8");
+    const workflow = safeLoad(workflowFileContent);
+
+    for (const job of Object.keys(workflow.jobs || {}).map(
+      (k) => workflow.jobs[k]
+    )) {
+      for (const step of job.steps || []) {
+        if (!!step.uses) {
+          // Check if allowed action
+          const [actionName, _] = step.uses.split("@");
+          if (!enabledActionsSet.has(actionName.toLowerCase())) {
+            return false;
+          }
+        }
+      }
+    }
+
+    // All used actions are enabled 🎉
+    return true;
+  } catch (e) {
+    console.error("Error while checking workflow", e);
+    throw e;
+  }
+}
+
+(async function main() {
+  try {
+    const settings = require("./settings.json");
+
+    const result = await checkWorkflows(
+      settings.folders,
+      settings.enabledActions
+    );
+
+    console.group(
+      `Found ${result.compatibleWorkflows.length} starter workflows compatible with GHES:`
+    );
+    console.log(
+      result.compatibleWorkflows.map((x) => `${x.folder}/${x.id}`).join("\n")
+    );
+    console.groupEnd();
+
+    console.group(
+      `Ignored ${result.incompatibleWorkflows.length} starter-workflows incompatible with GHES:`
+    );
+    console.log(
+      result.incompatibleWorkflows.map((x) => `${x.folder}/${x.id}`).join("\n")
+    );
+    console.groupEnd();
+
+    console.log("Switch to GHES branch");
+    await exec("git", ["checkout", "ghes"]);
+
+    // In order to sync from master, we might need to remove some workflows, add some
+    // and modify others. The lazy approach is to delete all workflows first, and then
+    // just bring the compatible ones over from the master branch. We let git figure out
+    // whether it's a deletion, add, or modify and commit the new state.
+    console.log("Remove all workflows");
+    await exec("rm", ["-fr", ...settings.folders]);
+
+    console.log("Sync changes from master for compatible workflows");
+    await exec("git", [
+      "checkout",
+      "master",
+      "--",
+      ...Array.prototype.concat.apply(
+        [],
+        result.compatibleWorkflows.map((x) => [
+          join(x.folder, `${x.id}.yml`),
+          join(x.folder, "properties", `${x.id}.properties.json`),
+        ])
+      ),
+    ]);
+  } catch (e) {
+    console.error("Unhandled error while syncing workflows", e);
+    process.exitCode = 1;
+  }
+})();
@@ -0,0 +1,112 @@
+{
+  "name": "sync-ghes-actions",
+  "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "@types/js-yaml": {
+      "version": "3.12.4",
+      "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-3.12.4.tgz",
+      "integrity": "sha512-fYMgzN+9e28R81weVN49inn/u798ruU91En1ZnGvSZzCRc5jXx9B2EDhlRaWmcO1RIxFHL8AajRXzxDuJu93+A==",
+      "dev": true
+    },
+    "@types/node": {
+      "version": "14.0.1",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.0.1.tgz",
+      "integrity": "sha512-FAYBGwC+W6F9+huFIDtn43cpy7+SzG+atzRiTfdp3inUKL2hXnd4rG8hylJLIh4+hqrQy1P17kvJByE/z825hA==",
+      "dev": true
+    },
+    "arg": {
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
+      "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
+      "dev": true
+    },
+    "argparse": {
+      "version": "1.0.10",
+      "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+      "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+      "requires": {
+        "sprintf-js": "~1.0.2"
+      }
+    },
+    "buffer-from": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz",
+      "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==",
+      "dev": true
+    },
+    "diff": {
+      "version": "4.0.2",
+      "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
+      "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==",
+      "dev": true
+    },
+    "esprima": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+      "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A=="
+    },
+    "js-yaml": {
+      "version": "3.13.1",
+      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz",
+      "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==",
+      "requires": {
+        "argparse": "^1.0.7",
+        "esprima": "^4.0.0"
+      }
+    },
+    "make-error": {
+      "version": "1.3.6",
+      "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
+      "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
+      "dev": true
+    },
+    "source-map": {
+      "version": "0.6.1",
+      "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+      "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+      "dev": true
+    },
+    "source-map-support": {
+      "version": "0.5.19",
+      "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz",
+      "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==",
+      "dev": true,
+      "requires": {
+        "buffer-from": "^1.0.0",
+        "source-map": "^0.6.0"
+      }
+    },
+    "sprintf-js": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+      "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw="
+    },
+    "ts-node": {
+      "version": "8.10.1",
+      "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-8.10.1.tgz",
+      "integrity": "sha512-bdNz1L4ekHiJul6SHtZWs1ujEKERJnHs4HxN7rjTyyVOFf3HaJ6sLqe6aPG62XTzAB/63pKRh5jTSWL0D7bsvw==",
+      "dev": true,
+      "requires": {
+        "arg": "^4.1.0",
+        "diff": "^4.0.1",
+        "make-error": "^1.1.1",
+        "source-map-support": "^0.5.17",
+        "yn": "3.1.1"
+      }
+    },
+    "typescript": {
+      "version": "3.9.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.2.tgz",
+      "integrity": "sha512-q2ktq4n/uLuNNShyayit+DTobV2ApPEo/6so68JaD5ojvc/6GClBipedB9zNWYxRSAlZXAe405Rlijzl6qDiSw==",
+      "dev": true
+    },
+    "yn": {
+      "version": "3.1.1",
+      "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
+      "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+      "dev": true
+    }
+  }
+}
@@ -0,0 +1,19 @@
+{
+  "name": "sync-ghes-actions",
+  "version": "1.0.0",
+  "main": "index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "github/c2c-actions-experience",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/js-yaml": "^3.12.4",
+    "@types/node": "^14.0.1",
+    "ts-node": "^8.10.1",
+    "typescript": "^3.9.2"
+  },
+  "dependencies": {
+    "js-yaml": "^3.13.1"
+  }
+}
@@ -0,0 +1,20 @@
+{
+  "folders": [
+    "../ci",
+    "../automation"
+  ],
+  "enabledActions": [
+    "actions/checkout",
+    "actions/create-release",
+    "actions/delete-package-versions",
+    "actions/download-artifact",
+    "actions/setup-dotnet",
+    "actions/setup-go",
+    "actions/setup-java",
+    "actions/setup-node",
+    "actions/stale",
+    "actions/starter-workflows",
+    "actions/upload-artifact",
+    "actions/upload-release-asset"
+  ]
+}
@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+  },
+  "include": ["*.ts"]
+}