@stelstone/server 0.27.0 → 0.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stelstone/server",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "Runtime-agnostic CMS server built on the Web Fetch API, with pluggable adapters for content, media, auth, and build.",
   "license": "MIT",
   "repository": {

package/src/adapters/build-github-actions.mjs

@@ -0,0 +1,104 @@
+/**
+ * GitHub Actions workflow runs as the deploy status source.
+ *
+ * For sites whose CI does the deploying — a Worker, a container, an rsync to
+ * a VPS — the workflow run IS the deploy, so its state is the honest thing to
+ * show. The adapter speaks the same vocabulary as the Netlify one so the
+ * admin's pill needs no per-provider knowledge.
+ *
+ * @param {Object} opts
+ * @param {string|undefined} opts.token   repo-scoped token; `actions:read`
+ * @param {string|undefined} opts.owner
+ * @param {string|undefined} opts.repo
+ * @param {string|undefined} opts.workflow  file name ("deploy.yml") or id;
+ *                                          omit to watch every workflow
+ * @param {string|undefined} opts.defaultBranch
+ * @returns {import('./types.mjs').BuildAdapter}
+ */
+import { createGitHubApi } from "./github-api.mjs";
+
+/**
+ * A finished run's conclusion, in the admin's state vocabulary.
+ *
+ * Anything that did not succeed but also did not fail outright — skipped by a
+ * path filter, superseded, stopped by hand — reads as "cancelled": the deploy
+ * did not happen, and that is not the same as a broken build.
+ */
+const CONCLUSION_STATE = {
+  success: "ready",
+  failure: "error",
+  timed_out: "error",
+  startup_failure: "error",
+  action_required: "error",
+  cancelled: "cancelled",
+  skipped: "cancelled",
+  stale: "cancelled",
+  neutral: "cancelled",
+};
+
+/** Queued and waiting-for-approval runs have not started; both are "queued". */
+const PENDING_STATUSES = new Set(["queued", "pending", "waiting", "requested"]);
+
+function runState(run) {
+  if (run.status === "completed") return CONCLUSION_STATE[run.conclusion] || "error";
+  return PENDING_STATUSES.has(run.status) ? "enqueued" : "building";
+}
+
+export function createGitHubActionsBuild({ token, owner, repo, workflow, defaultBranch }) {
+  const configured = Boolean(token && owner && repo);
+  const api = configured ? createGitHubApi({ token, owner, repo }) : null;
+
+  return {
+    configured,
+
+    async getDeployStatus({ branch, sha } = {}) {
+      if (!configured) return { configured: false };
+
+      const query = new URLSearchParams({ per_page: "20" });
+      const targetBranch = branch || defaultBranch;
+      if (targetBranch) query.set("branch", targetBranch);
+      const path = workflow
+        ? `/actions/workflows/${encodeURIComponent(workflow)}/runs?${query}`
+        : `/actions/runs?${query}`;
+
+      const body = await api.apiGet(path);
+      // apiGet answers null on 404 — for a run listing that means the repo,
+      // the workflow name or the token is wrong, not "no runs yet". Say so
+      // instead of returning an empty list the caller would poll forever.
+      if (!body) {
+        const err = new Error(`GitHub API 404 GET ${path}`);
+        err.upstreamStatus = 404;
+        throw err;
+      }
+
+      const runs = body.workflow_runs || [];
+      let run = null;
+      if (sha) {
+        run = runs.find((r) => r.head_sha && r.head_sha.startsWith(sha));
+        // SHA not there yet — the push has not produced a run, keep waiting.
+        if (!run) return { configured: true, deploy: null };
+      }
+      if (!run) run = runs[0] || null;
+      if (!run) return { configured: true, deploy: null };
+
+      return {
+        configured: true,
+        deploy: {
+          id: run.id,
+          state: runState(run),
+          branch: run.head_branch,
+          commitRef: run.head_sha,
+          // Actions knows what it ran, not where the result is published, so
+          // the run page is the only link worth offering.
+          deployUrl: null,
+          adminUrl: run.html_url || null,
+          createdAt: run.created_at,
+          updatedAt: run.updated_at,
+          // A run carries no failure text; the run page has the logs.
+          errorMessage: null,
+          title: run.display_title || run.name || null,
+        },
+      };
+    },
+  };
+}

package/src/adapters/index.mjs

@@ -8,5 +8,6 @@ export { createBasicAuth } from "./basic-auth.mjs";
 export { createGitHubOAuth } from "./github-oauth.mjs";
 export { createCloudflareAccess } from "./cloudflare-access.mjs";
 export { createNetlifyBuild } from "./build-netlify.mjs";
+export { createGitHubActionsBuild } from "./build-github-actions.mjs";
 export { createMediaUrl } from "./media-url.mjs";
 export { createResendMail } from "./resend-mail.mjs";

package/src/core/adapter-options.mjs

@@ -16,20 +16,29 @@
 /** @typedef {(name: string) => string|undefined} SecretLookup */
 
 /**
- * Options for `createGitHubContent`.
- * @param {Object} config
+ * GITHUB_REPO ("owner/repo") overrides the config — set where the secrets
+ * already live, so a deploy-button user never edits a file. Lenient about
+ * pasted URLs: the last two path segments are the coordinates.
+ *
  * @param {SecretLookup} secrets
+ * @returns {{owner?: string, repo?: string}}
  */
-export function githubContentOptions(config, secrets) {
-  // GITHUB_REPO ("owner/repo") overrides the config — set where the secrets
-  // already live, so a deploy-button user never edits a file. Lenient about
-  // pasted URLs: the last two path segments are the coordinates.
-  const repoEnv = String(secrets("GITHUB_REPO") ?? "")
+function repoFromEnv(secrets) {
+  const parts = String(secrets("GITHUB_REPO") ?? "")
     .replace(/\.git$/, "")
     .split(/[/:]/)
     .filter(Boolean)
     .slice(-2);
-  const [envOwner, envRepo] = repoEnv.length === 2 ? repoEnv : [];
+  return parts.length === 2 ? { owner: parts[0], repo: parts[1] } : {};
+}
+
+/**
+ * Options for `createGitHubContent`.
+ * @param {Object} config
+ * @param {SecretLookup} secrets
+ */
+export function githubContentOptions(config, secrets) {
+  const { owner: envOwner, repo: envRepo } = repoFromEnv(secrets);
   return {
     token: secrets(config.content.githubTokenEnv || "GITHUB_TOKEN"),
     owner: envOwner || config.content.owner,
@@ -135,11 +144,54 @@ export function netlifyBuildOptions(config, secrets) {
   return {
     token: secrets(config.build?.netlifyTokenEnv || "NETLIFY_AUTH_TOKEN"),
     siteId: secrets(config.build?.netlifySiteIdEnv || "NETLIFY_SITE_ID"),
-    defaultBranch:
-      secrets("STAGING_BRANCH") || config.content?.publishBranch || config.content?.branch,
+    defaultBranch: buildDefaultBranch(config, secrets),
   };
 }
 
+/**
+ * The branch whose deploy the admin's status pill follows. `STAGING_BRANCH`
+ * wins for the same reason it does for content: it is what redirects a whole
+ * deployment onto another branch.
+ */
+function buildDefaultBranch(config, secrets) {
+  return secrets("STAGING_BRANCH") || config.content?.publishBranch || config.content?.branch;
+}
+
+/**
+ * Which build adapter to construct, and with what.
+ *
+ * Mirrors `authOptions`: the caller stays free of the naming rules and only
+ * has to map a provider name onto a factory. Netlify remains the default so
+ * existing configs keep working untouched.
+ *
+ * @param {Object} config
+ * @param {SecretLookup} secrets
+ * @returns {{provider: string, options: object}}
+ */
+export function buildOptions(config, secrets) {
+  const build = config.build ?? {};
+  const provider = build.provider ?? "netlify";
+
+  if (provider === "github-actions") {
+    // Defaults to the repo the content already comes from — for a site whose
+    // CI deploys it, that is nearly always the same repo, and the token that
+    // reads content can read its runs.
+    const { owner: envOwner, repo: envRepo } = repoFromEnv(secrets);
+    return {
+      provider,
+      options: {
+        token: secrets(build.githubTokenEnv || config.content?.githubTokenEnv || "GITHUB_TOKEN"),
+        owner: envOwner || build.owner || config.content?.owner,
+        repo: envRepo || build.repo || config.content?.repo,
+        workflow: build.workflow,
+        defaultBranch: buildDefaultBranch(config, secrets),
+      },
+    };
+  }
+
+  return { provider: "netlify", options: netlifyBuildOptions(config, secrets) };
+}
+
 /**
  * Options for `createCdnProxyMedia`.
  * @param {Object} config

package/src/core/config-schema.mjs

@@ -321,6 +321,53 @@ function checkForward(forward, at, report, getSecret) {
   }
 }
 
+/**
+ * `build` decides where the admin's deploy pill gets its status. It is
+ * optional — a site with no CI simply shows no pill — but a misspelled
+ * provider silently falls back to Netlify, which for a site that does not use
+ * Netlify means a pill that never resolves. Name it.
+ */
+function checkBuild(config, report, { getSecret }) {
+  const build = config.build;
+  if (build === undefined) return;
+  if (typeof build !== "object" || build === null) {
+    report.error("build", "must be an object");
+    return;
+  }
+
+  const provider = build.provider ?? "netlify";
+  if (!["netlify", "github-actions"].includes(provider)) {
+    report.error("build.provider", `unknown provider "${provider}" — expected netlify or github-actions`);
+    return;
+  }
+
+  if (provider === "github-actions") {
+    const owner = build.owner || config.content?.owner;
+    const repo = build.repo || config.content?.repo;
+    // GITHUB_REPO can supply both at runtime, so this is a warning: the
+    // coordinates may well arrive from the environment.
+    if (!owner || !repo) {
+      report.warn(
+        "build",
+        "owner/repo not in the config — deploy status needs them, from build.owner/build.repo, content, or GITHUB_REPO",
+      );
+    }
+    const tokenEnv = build.githubTokenEnv || config.content?.githubTokenEnv || "GITHUB_TOKEN";
+    if (!getSecret(tokenEnv)) {
+      report.warn("build.githubTokenEnv", `${tokenEnv} is not set — deploy status is unavailable`);
+    }
+    return;
+  }
+
+  for (const [key, fallback] of [
+    ["netlifyTokenEnv", "NETLIFY_AUTH_TOKEN"],
+    ["netlifySiteIdEnv", "NETLIFY_SITE_ID"],
+  ]) {
+    const name = build[key] || fallback;
+    if (!getSecret(name)) report.warn(`build.${key}`, `${name} is not set — deploy status is unavailable`);
+  }
+}
+
 function checkMisc(config, report) {
   const { locales, defaultLocale } = config;
   if (locales !== undefined && !Array.isArray(locales)) {
@@ -372,6 +419,7 @@ export function validateConfig(config, { runtime = "node", getSecret } = {}) {
   checkAuth(config, report, { getSecret: lookup });
   checkCollections(config, report);
   checkForms(config, report, { getSecret: lookup });
+  checkBuild(config, report, { getSecret: lookup });
   checkMisc(config, report);
 
   return { errors: report.errors, warnings: report.warnings };
@@ -445,7 +493,10 @@ export function describeConfig(config, { adapters, getSecret, runtime = "node" }
     lines.push(`media    ${config.media.cdnBase}${config.media.tenantId ? ` (tenant: ${config.media.tenantId})` : ""}`);
   }
   if (adapters?.build) {
-    lines.push(`build    netlify — ${adapters.build.configured ? "configured" : "not configured"}`);
+    const buildProvider = config.build?.provider ?? "netlify";
+    lines.push(
+      `build    ${buildProvider} — ${adapters.build.configured ? "configured" : "not configured"}`,
+    );
   }
 
   const collections = Object.keys(config.collections || {});

package/src/server.mjs

@@ -12,7 +12,7 @@ import {
   fsContentOptions,
   githubTemplatesOptions,
   authOptions,
-  netlifyBuildOptions,
+  buildOptions,
   cdnMediaOptions,
   mailOptions,
 } from "./core/adapter-options.mjs";
@@ -25,6 +25,7 @@ import {
   createGitHubOAuth,
   createCloudflareAccess,
   createNetlifyBuild,
+  createGitHubActionsBuild,
   createFsTemplates,
   createGitHubTemplates,
   createResendMail,
@@ -79,7 +80,11 @@ export function createCmsServer({ config, rootDir, publicConfig: publicConfigFn,
   // No media config → no CDN adapter; the media routes answer 404 instead
   // of every /api request dying while the adapter bag is built.
   const cdnMedia = config.media ? createCdnProxyMedia(cdnMediaOptions(config, auth)) : undefined;
-  const build = createNetlifyBuild(netlifyBuildOptions(config, secrets));
+  const { provider: buildProvider, options: buildOpts } = buildOptions(config, secrets);
+  const build =
+    buildProvider === "github-actions"
+      ? createGitHubActionsBuild(buildOpts)
+      : createNetlifyBuild(buildOpts);
 
   const templates = useGitHub
     ? createGitHubTemplates(githubTemplatesOptions(config, secrets))

package/src/version.mjs

@@ -5,4 +5,4 @@
  * require() and no import.meta.url, so reading the manifest at runtime yields
  * "unknown" there.
  */
-export const SERVER_VERSION = "0.27.0";
+export const SERVER_VERSION = "0.28.0";