@goodfellow-cms/github 0.8.0 → 0.9.0

package/dist/index.d.ts

@@ -134,19 +134,19 @@ export declare class GitHubBackend implements GitBackend {
   readAt(path: string, revision: string): Promise<string | undefined>;
   changedPaths(from: string, to: string): Promise<string[]>;
   /**
-   * Reads the deployment GitHub Pages or Vercel created for a commit, or what
-   * Cloudflare Pages reports on it, and for GitHub Actions, the workflow run
+   * Reads the deployment GitHub Pages, Vercel or Netlify created for a commit,
+   * or what Cloudflare Pages or Netlify reports on it, and for GitHub Actions, the workflow run
    * that builds it: a build that fails never creates a deployment. Before any
    * exists, the site counts as building if it has ever been deployed, or if
    * Cloudflare reported on the commit before.
    */
   deployStatus(revision: string): Promise<DeployStatus>;
   /**
-   * What Cloudflare Pages reports on a commit: a check run of its GitHub App,
-   * or a commit status, which fine-grained tokens can read where check runs
-   * need a GitHub App's permission. `undefined` if it reported nothing.
+   * What Cloudflare Pages or Netlify reports on a commit: a check run of its
+   * GitHub App, or a commit status, which fine-grained tokens can read where
+   * check runs need a GitHub App's permission. `undefined` if it reported nothing.
    */
-  private cloudflareBuild;
+  private hostBuild;
   /** The commit a commit was made on top of, if the token can see it. */
   private parentOf;
   /** The site's deploy workflow run for a commit, or `undefined` if there's none or the token can't see Actions. */

package/dist/index.js

@@ -860,8 +860,14 @@ function githubCodeUpdates(options) {
 }
 //#endregion
 //#region src/backend.ts
-/** Cloudflare Pages' check runs (its GitHub App is "Cloudflare Workers and Pages") and commit statuses. */
-const CLOUDFLARE = /cloudflare/i;
+/**
+* The check runs and commit statuses of hosts that build the site themselves
+* and report to GitHub: Cloudflare Pages (its GitHub App is "Cloudflare Workers
+* and Pages") and Netlify's deploys (`netlify/<site>/deploy…`), but not its
+* other checks, such as "Header rules", which finish before the deploy does.
+* Netlify's GitHub App also creates a deployment, which `deployStatus()` reads first.
+*/
+const HOST_BUILDS = /cloudflare|netlify\/\S+\/deploy/i;
 /** How many files one GraphQL request reads. */
 const GRAPHQL_BATCH = 100;
 /** The most files GitHub's compare lists. */
@@ -1301,8 +1307,8 @@ var GitHubBackend = class GitHubBackend {
 		return [...new Set(files.flatMap((file) => [file.filename, file.previous_filename ?? []].flat()))];
 	}
 	/**
-	* Reads the deployment GitHub Pages or Vercel created for a commit, or what
-	* Cloudflare Pages reports on it, and for GitHub Actions, the workflow run
+	* Reads the deployment GitHub Pages, Vercel or Netlify created for a commit,
+	* or what Cloudflare Pages or Netlify reports on it, and for GitHub Actions, the workflow run
 	* that builds it: a build that fails never creates a deployment. Before any
 	* exists, the site counts as building if it has ever been deployed, or if
 	* Cloudflare reported on the commit before.
@@ -1334,8 +1340,8 @@ var GitHubBackend = class GitHubBackend {
 					};
 				}
 			}
-			const cloudflare = await this.cloudflareBuild(revision);
-			if (cloudflare) return cloudflare;
+			const hosted = await this.hostBuild(revision);
+			if (hosted) return hosted;
 			const run = await this.workflowRun(revision);
 			if (run?.status === "completed" && run.conclusion === "cancelled") {
 				const head = await this.head();
@@ -1352,22 +1358,22 @@ var GitHubBackend = class GitHubBackend {
 			};
 			if ((await githubJson(this.api, `/repos/${this.repo}/deployments?per_page=1`)).length > 0) return { state: "building" };
 			const parent = await this.parentOf(revision);
-			return { state: parent && await this.cloudflareBuild(parent) ? "building" : "unknown" };
+			return { state: parent && await this.hostBuild(parent) ? "building" : "unknown" };
 		} catch (error) {
 			if (error instanceof GitApiError) return { state: "unknown" };
 			throw error;
 		}
 	}
 	/**
-	* What Cloudflare Pages reports on a commit: a check run of its GitHub App,
-	* or a commit status, which fine-grained tokens can read where check runs
-	* need a GitHub App's permission. `undefined` if it reported nothing.
+	* What Cloudflare Pages or Netlify reports on a commit: a check run of its
+	* GitHub App, or a commit status, which fine-grained tokens can read where
+	* check runs need a GitHub App's permission. `undefined` if it reported nothing.
 	*/
-	async cloudflareBuild(revision) {
+	async hostBuild(revision) {
 		const checks = await githubRequest(this.api, `/repos/${this.repo}/commits/${revision}/check-runs?per_page=50`, { allow: [403, 404] });
 		if (checks.ok) {
 			const { check_runs: found = [] } = await checks.json();
-			const run = found.find((candidate) => CLOUDFLARE.test(`${candidate.app?.slug ?? ""} ${candidate.name}`));
+			const run = found.find((candidate) => HOST_BUILDS.test(`${candidate.app?.slug ?? ""} ${candidate.name}`));
 			if (run) {
 				const detailsUrl = run.details_url ?? run.html_url ?? void 0;
 				if (run.status !== "completed") return {
@@ -1390,7 +1396,7 @@ var GitHubBackend = class GitHubBackend {
 		}
 		const statuses = await githubRequest(this.api, `/repos/${this.repo}/commits/${revision}/statuses?per_page=50`, { allow: [403, 404] });
 		if (!statuses.ok) return void 0;
-		const status = (await statuses.json()).find((candidate) => CLOUDFLARE.test(candidate.context));
+		const status = (await statuses.json()).find((candidate) => HOST_BUILDS.test(candidate.context));
 		if (!status) return void 0;
 		const detailsUrl = status.target_url ?? void 0;
 		if (status.state === "success") return {

package/dist/testing.d.ts

@@ -87,6 +87,14 @@ export interface FakeGitHubOptions {
     afterChecks: number;
     report?: "check-runs" | "statuses";
   };
+  /**
+   * Simulates Netlify, as `cloudflare` does Cloudflare Pages: its GitHub App's
+   * "Header rules" check run, which finishes at once, and a commit status for
+   * the deploy, which reports success after being checked this many times.
+   */
+  netlify?: {
+    afterChecks: number;
+  };
   /** Answers 403 to reading check runs, as GitHub does for fine-grained tokens, which can't have the permission. */
   checkRunsForbidden?: boolean;
   /** Organizations the users belong to, which new repositories can be created in. */

package/dist/testing.js

@@ -623,7 +623,7 @@ function fakeGitHub(options) {
 		}
 	}
 	function deploy(sha) {
-		if (options.cloudflare) cloudflareBuilds.set(sha, { checks: 0 });
+		if (options.cloudflare || options.netlify) cloudflareBuilds.set(sha, { checks: 0 });
 		if (options.deployAfterChecks === void 0) return;
 		deployments.unshift({
 			id: nextDeployment++,
@@ -638,7 +638,7 @@ function fakeGitHub(options) {
 		if (!build) return void 0;
 		build.checks += 1;
 		if (build.failed) return "failure";
-		return build.checks > (options.cloudflare?.afterChecks ?? 0) ? "success" : "building";
+		return build.checks > (options.cloudflare?.afterChecks ?? options.netlify?.afterChecks ?? 0) ? "success" : "building";
 	}
 	function failCloudflare(sha) {
 		cloudflareBuilds.set(sha, {
@@ -1261,6 +1261,19 @@ function fakeGitHub(options) {
 		const checkRunsSha = rest.match(/^\/commits\/([0-9a-f]{40})\/check-runs$/)?.[1];
 		if (checkRunsSha) {
 			if (options.checkRunsForbidden) return json({ message: "Resource not accessible by personal access token" }, 403);
+			if (options.netlify) {
+				const known = cloudflareBuilds.has(checkRunsSha);
+				return json({
+					total_count: known ? 1 : 0,
+					check_runs: known ? [{
+						id: 1,
+						name: "Header rules - parish",
+						app: { slug: "netlify" },
+						status: "completed",
+						conclusion: "neutral"
+					}] : []
+				});
+			}
 			const state = options.cloudflare?.report === "statuses" ? void 0 : cloudflareState(checkRunsSha);
 			const runsFound = state ? [{
 				id: 1,
@@ -1278,6 +1291,15 @@ function fakeGitHub(options) {
 		}
 		const statusesSha = rest.match(/^\/commits\/([0-9a-f]{40})\/statuses$/)?.[1];
 		if (statusesSha) {
+			if (options.netlify) {
+				const deploy = cloudflareState(statusesSha);
+				return json(deploy ? [{
+					context: "netlify/parish/deploy-preview",
+					state: deploy === "building" ? "pending" : deploy,
+					target_url: `https://app.netlify.com/sites/parish/deploys/${statusesSha}`,
+					description: deploy === "failure" ? "Deploy failed" : "Deploy is ready!"
+				}] : []);
+			}
 			const state = options.cloudflare?.report === "statuses" ? cloudflareState(statusesSha) : void 0;
 			return json(state ? [{
 				context: "Cloudflare Pages",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@goodfellow-cms/github",
-  "version": "0.8.0",
-  "description": "Edit a Goodfellow site stored on GitHub, straight from the browser.",
+  "version": "0.9.0",
+  "description": "Edit a Goodfellow CMS site stored on GitHub, straight from the browser.",
   "keywords": [
     "goodfellow",
     "cms",
@@ -12,6 +12,10 @@
   ],
   "homepage": "https://goodfellow-cms.github.io/goodfellow-cms/docs/hosts",
   "bugs": "https://github.com/goodfellow-cms/goodfellow-cms/issues",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/goodfellow-cms"
+  },
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -35,7 +39,7 @@
     "dist"
   ],
   "dependencies": {
-    "@goodfellow-cms/core": "0.8.0",
+    "@goodfellow-cms/core": "0.9.0",
     "@noble/ciphers": "2.4.0",
     "@noble/hashes": "2.4.0"
   },