@handong66/evidoc-github-action 0.1.0

package/dist/src/index.d.ts

@@ -0,0 +1,21 @@
+import { type DriftReport } from "@handong66/evidoc-core";
+export type FailOn = "none" | "broken" | "review_needed";
+export interface ActionPolicy {
+    failOn: FailOn;
+}
+export interface GithubActionOptions extends ActionPolicy {
+    cwd: string;
+    changedFiles?: string[];
+}
+export interface GithubActionResult {
+    exitCode: number;
+    report: DriftReport;
+    setupWarnings: string[];
+    markdownSummary: string;
+    annotations: string;
+    prComment: string;
+    sarif: string;
+}
+export declare function shouldFailAction(report: DriftReport, policy: ActionPolicy): boolean;
+export declare function runGithubAction(options: GithubActionOptions): Promise<GithubActionResult>;
+export declare function parseFailOn(value: string | undefined): FailOn;

package/dist/src/index.js

@@ -0,0 +1,94 @@
+import { readFile, readdir } from "node:fs/promises";
+import { join } from "node:path";
+import { checkRepository, detectRepositoryEvidocWorkflowText, evidocWorkflowWarnings } from "@handong66/evidoc-core";
+import { formatGithubAnnotations, formatMarkdownReport, formatPrComment, formatSarifReport } from "@handong66/evidoc-reports";
+export function shouldFailAction(report, policy) {
+    if (policy.failOn === "none")
+        return false;
+    if (policy.failOn === "broken")
+        return report.summary.broken > 0;
+    return report.summary.broken > 0 || report.summary.reviewNeeded > 0;
+}
+export async function runGithubAction(options) {
+    const report = await checkRepository(options.cwd, { changedFiles: options.changedFiles });
+    const setupWarnings = await findEvidocWorkflowWarnings(options.cwd);
+    const reportFormatOptions = {
+        setupWarnings,
+        scanScope: options.changedFiles === undefined ? undefined : "changed-only"
+    };
+    const markdownSummary = formatMarkdownReport(report, reportFormatOptions);
+    return {
+        exitCode: shouldFailAction(report, options) ? 1 : 0,
+        report,
+        setupWarnings,
+        markdownSummary,
+        annotations: formatGithubAnnotations(report),
+        prComment: formatPrComment(report, reportFormatOptions),
+        sarif: formatSarifReport(report)
+    };
+}
+async function findEvidocWorkflowWarnings(root) {
+    const workflowsRoot = join(root, ".github", "workflows");
+    let entries;
+    try {
+        entries = await readdir(workflowsRoot);
+    }
+    catch {
+        return [];
+    }
+    const warnings = [];
+    const defaultBranch = await readGithubEventDefaultBranch();
+    for (const entry of entries.sort()) {
+        if (!entry.endsWith(".yml") && !entry.endsWith(".yaml"))
+            continue;
+        const workflowPath = `.github/workflows/${entry}`;
+        let text;
+        try {
+            text = await readFile(join(root, workflowPath), "utf8");
+        }
+        catch {
+            continue;
+        }
+        const detection = await detectRepositoryEvidocWorkflowText(root, text);
+        if (detection.matches) {
+            warnings.push(...evidocWorkflowWarnings(workflowPath, text, defaultBranch));
+            for (const action of detection.localActions) {
+                warnings.push(...evidocWorkflowWarnings(action.path, action.text, undefined));
+            }
+        }
+    }
+    return warnings;
+}
+async function readGithubEventDefaultBranch() {
+    const eventPath = process.env.GITHUB_EVENT_PATH;
+    if (!eventPath)
+        return undefined;
+    try {
+        const event = JSON.parse(await readFile(eventPath, "utf8"));
+        return sanitizeBranchName(typeof event.repository?.default_branch === "string" ? event.repository.default_branch : undefined);
+    }
+    catch {
+        return undefined;
+    }
+}
+function sanitizeBranchName(value) {
+    const branch = value?.trim();
+    if (!branch || !isSafeBranchName(branch))
+        return undefined;
+    return branch;
+}
+function isSafeBranchName(branch) {
+    if (branch === "@" || branch.startsWith("/") || branch.endsWith("/") || branch.endsWith("."))
+        return false;
+    if (branch.includes("..") || branch.includes("//") || branch.includes("@{"))
+        return false;
+    if (branch.split("/").some((part) => part.startsWith(".") || part.endsWith(".lock")))
+        return false;
+    return !/[\x00-\x20\x7f~^:?*[\]\\`]/.test(branch);
+}
+export function parseFailOn(value) {
+    if (value === "broken" || value === "review_needed" || value === "none")
+        return value;
+    return "review_needed";
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EACL,eAAe,EACf,kCAAkC,EAClC,sBAAsB,EAEvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AAuBnC,MAAM,UAAU,gBAAgB,CAAC,MAAmB,EAAE,MAAoB;IACxE,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,GAAG,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAA4B;IAChE,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC1F,MAAM,aAAa,GAAG,MAAM,0BAA0B,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpE,MAAM,mBAAmB,GAAG;QAC1B,aAAa;QACb,SAAS,EAAE,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,cAAwB;KACtF,CAAC;IACF,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAE1E,OAAO;QACL,QAAQ,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM;QACN,aAAa;QACb,eAAe;QACf,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC;QAC5C,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,mBAAmB,CAAC;QACvD,KAAK,EAAE,iBAAiB,CAAC,MAAM,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,0BAA0B,CAAC,IAAY;IACpD,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,IAAI,OAAiB,CAAC;IACtB,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,aAAa,GAAG,MAAM,4BAA4B,EAAE,CAAC;IAE3D,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,SAAS;QAClE,MAAM,YAAY,GAAG,qBAAqB,KAAK,EAAE,CAAC;QAClD,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,kCAAkC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACtB,QAAQ,CAAC,IAAI,CAAC,GAAG,sBAAsB,CAAC,YAAY,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5E,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;gBAC5C,QAAQ,CAAC,IAAI,CAAC,GAAG,sBAAsB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;YAChF,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,4BAA4B;IACzC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAChD,IAAI,CAAC,SAAS;QAAE,OAAO,SAAS,CAAC;IACjC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAkD,CAAC;QAC7G,OAAO,kBAAkB,CACvB,OAAO,KAAK,CAAC,UAAU,EAAE,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CACnG,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAyB;IACnD,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IAC3D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3G,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1F,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACnG,OAAO,CAAC,4BAA4B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAyB;IACnD,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,eAAe,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IACtF,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@handong66/evidoc-github-action",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "prepublishOnly": "node ../../scripts/ensure-built-package.mjs"
+  },
+  "exports": {
+    ".": "./dist/src/index.js"
+  },
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist/src"
+  ],
+  "dependencies": {
+    "@handong66/evidoc-core": "0.1.0",
+    "@handong66/evidoc-reports": "0.1.0"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/handong66/Evidoc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/handong66/Evidoc/issues"
+  },
+  "homepage": "https://github.com/handong66/Evidoc#readme"
+}