Enforce root layout container to be always present

.github/actions/deploy-vercel/action.yml

@@ -1,6 +1,10 @@
-# This action handles updating the target commit env variable (`RELEASE_COMMIT`)
-# which is used as the pointer for `rerun.io/docs` and `rerun.io/examples`
-# and triggering a redeploy of `rerun.io`.
+# If `target` is set to `production`, this action handles updating the
+# target commit env variable (`RELEASE_COMMIT`) which is used as the
+# pointer for `rerun.io/docs` and `rerun.io/examples` and triggering
+# a redeploy of `rerun.io`.
+
+# If `target` is set to `preview`, then this instead deploys a fresh preview
+# with an override for `release_commit`, and sets the `vercel_preview_url` output.
 
 name: "Deploy rerun.io"
 
@@ -25,6 +29,10 @@ inputs:
   release_version:
     description: "Which release version to update the deployment to"
     type: string
+    required: false
+  target:
+    description: "Which Vercel environment to deploy to"
+    type: string
     required: true
 
 runs:

.github/actions/deploy-vercel/index.mjs

@@ -1,63 +1,32 @@
 // @ts-check
 
 import { Client } from "./vercel.mjs";
-import { assert, getRequiredInput, info } from "./util.mjs";
+import { assert, getInput, getRequiredInput } from "./util.mjs";
+import { deployToProduction } from "./production.mjs";
+import { deployToPreview } from "./preview.mjs";
 
 // These inputs are defined in `action.yml`, and should be kept in sync
 const token = getRequiredInput("vercel_token");
-const teamName = getRequiredInput("vercel_team_name");
-const projectName = getRequiredInput("vercel_project_name");
-const releaseCommit = getRequiredInput("release_commit");
-const releaseVersion = getRequiredInput("release_version");
+const team = getRequiredInput("vercel_team_name");
+const project = getRequiredInput("vercel_project_name");
+const commit = getRequiredInput("release_commit");
+const target = getRequiredInput("target");
 
 const client = new Client(token);
 
-info`Fetching team "${teamName}"`;
-const availableTeams = await client.teams();
-assert(availableTeams, `failed to get team "${teamName}"`);
-const team = availableTeams.find((team) => team.name === teamName);
-assert(team, `failed to get team "${teamName}"`);
-
-info`Fetching project "${projectName}"`;
-const projectsInTeam = await client.projects(team.id);
-const project = projectsInTeam.find((project) => project.name === projectName);
-assert(project, `failed to get project "${projectName}"`);
-
-info`Fetching latest production deployment`;
-const productionDeployments = await client.deployments(team.id, project.id);
-const latestProductionDeployment = productionDeployments[0];
-assert(
-  latestProductionDeployment,
-  `failed to get latest production deployment`,
-);
-
-const environment = await client.envs(team.id, project.id);
-const RELEASE_COMMIT_KEY = "RELEASE_COMMIT";
-const RELEASE_VERSION_KEY = "RELEASE_VERSION";
-
-info`Fetching "${RELEASE_COMMIT_KEY}" env var`;
-const releaseCommitEnv = environment.find(
-  (env) => env.key === RELEASE_COMMIT_KEY,
-);
-assert(releaseCommitEnv, `failed to get "${RELEASE_COMMIT_KEY}" env var`);
-
-info`Fetching "${RELEASE_VERSION_KEY}" env var`;
-const releaseVersionEnv = environment.find(
-  (env) => env.key === RELEASE_VERSION_KEY,
-);
-assert(releaseVersionEnv, `failed to get "${RELEASE_VERSION_KEY}" env var`);
-
-info`Setting "${RELEASE_COMMIT_KEY}" env to "${releaseCommit}"`;
-await client.setEnv(team.id, project.id, releaseCommitEnv.id, {
-  key: RELEASE_COMMIT_KEY,
-  value: releaseCommit,
-});
-
-info`Setting "${RELEASE_VERSION_KEY}" env to "${releaseVersion}"`;
-await client.setEnv(team.id, project.id, releaseVersionEnv.id, {
-  key: RELEASE_VERSION_KEY,
-  value: releaseVersion,
-});
-
-info`Triggering redeploy`;
-await client.redeploy(team.id, latestProductionDeployment.uid, "landing");
+switch (target) {
+  case "production": {
+    const version = getRequiredInput("release_version");
+    await deployToProduction(client, { team, project, commit, version });
+    break;
+  }
+
+  case "preview": {
+    await deployToPreview(client, { team, project, commit });
+    break;
+  }
+
+  default: {
+    throw new Error(`"target" must be one of: production, preview`);
+  }
+}

.github/actions/deploy-vercel/preview.mjs

@@ -0,0 +1,49 @@
+// @ts-check
+
+import { assert, info, setOutput } from "./util.mjs";
+import { Client } from "./vercel.mjs";
+
+/**
+ *
+ * @param {Client} client
+ * @param {{
+ *   team: string;
+ *   project: string;
+ *   commit: string;
+ * }} options
+ */
+export async function deployToPreview(client, options) {
+  info`Fetching team "${options.team}"`;
+  const availableTeams = await client.teams();
+  assert(availableTeams, `failed to get team "${options.team}"`);
+  const team = availableTeams.find((team) => team.name === options.team);
+  assert(team, `failed to get team "${options.team}"`);
+
+  info`Fetching project "${options.project}"`;
+  const projectsInTeam = await client.projects(team.id);
+  const project = projectsInTeam.find(
+    (project) => project.name === options.project,
+  );
+  assert(project, `failed to get project "${options.project}"`);
+
+  info`Fetching latest production deployment`;
+  const productionDeployments = await client.deployments(team.id, project.id);
+  const latestProductionDeployment = productionDeployments[0];
+  assert(
+    latestProductionDeployment,
+    `failed to get latest production deployment`,
+  );
+
+  info`Deploying preview with RELEASE_COMMIT=${options.commit}`;
+  const { url } = await client.deployPreviewFrom(
+    team.id,
+    latestProductionDeployment.uid,
+    "landing-preview",
+    {
+      RELEASE_COMMIT: options.commit,
+      IS_PR_PREVIEW: "true",
+    },
+  );
+
+  setOutput("vercel_preview_url", url);
+}

.github/actions/deploy-vercel/production.mjs

@@ -0,0 +1,68 @@
+// @ts-check
+
+import { assert, info } from "./util.mjs";
+import { Client } from "./vercel.mjs";
+
+/**
+ *
+ * @param {Client} client
+ * @param {{
+ *   team: string;
+ *   project: string;
+ *   commit: string;
+ *   version: string;
+ * }} options
+ */
+export async function deployToProduction(client, options) {
+  info`Fetching team "${options.team}"`;
+  const availableTeams = await client.teams();
+  assert(availableTeams, `failed to get team "${options.team}"`);
+  const team = availableTeams.find((team) => team.name === options.team);
+  assert(team, `failed to get team "${options.team}"`);
+
+  info`Fetching project "${options.project}"`;
+  const projectsInTeam = await client.projects(team.id);
+  const project = projectsInTeam.find(
+    (project) => project.name === options.project,
+  );
+  assert(project, `failed to get project "${options.project}"`);
+
+  info`Fetching latest production deployment`;
+  const productionDeployments = await client.deployments(team.id, project.id);
+  const latestProductionDeployment = productionDeployments[0];
+  assert(
+    latestProductionDeployment,
+    `failed to get latest production deployment`,
+  );
+
+  const environment = await client.envs(team.id, project.id);
+  const RELEASE_COMMIT_KEY = "RELEASE_COMMIT";
+  const RELEASE_VERSION_KEY = "RELEASE_VERSION";
+
+  info`Fetching "${RELEASE_COMMIT_KEY}" env var`;
+  const releaseCommitEnv = environment.find(
+    (env) => env.key === RELEASE_COMMIT_KEY,
+  );
+  assert(releaseCommitEnv, `failed to get "${RELEASE_COMMIT_KEY}" env var`);
+
+  info`Fetching "${RELEASE_VERSION_KEY}" env var`;
+  const releaseVersionEnv = environment.find(
+    (env) => env.key === RELEASE_VERSION_KEY,
+  );
+  assert(releaseVersionEnv, `failed to get "${RELEASE_VERSION_KEY}" env var`);
+
+  info`Setting "${RELEASE_COMMIT_KEY}" env to "${options.commit}"`;
+  await client.setEnv(team.id, project.id, releaseCommitEnv.id, {
+    key: RELEASE_COMMIT_KEY,
+    value: options.commit,
+  });
+
+  info`Setting "${RELEASE_VERSION_KEY}" env to "${options.version}"`;
+  await client.setEnv(team.id, project.id, releaseVersionEnv.id, {
+    key: RELEASE_VERSION_KEY,
+    value: options.version,
+  });
+
+  info`Triggering redeploy`;
+  await client.redeploy(team.id, latestProductionDeployment.uid, "landing");
+}

.github/actions/deploy-vercel/test.mjs

@@ -0,0 +1,38 @@
+// @ts-check
+
+import { Client } from "./vercel.mjs";
+import { assert, info } from "./util.mjs";
+
+const client = new Client("NzuZ9WBTnfUGiwHrhd7mit2E");
+
+const teamName = "rerun";
+const projectName = "landing";
+
+info`Fetching team "${teamName}"`;
+const availableTeams = await client.teams();
+assert(availableTeams, `failed to get team "${teamName}"`);
+const team = availableTeams.find((team) => team.name === teamName);
+assert(team, `failed to get team "${teamName}"`);
+
+info`Fetching project "${projectName}"`;
+const projectsInTeam = await client.projects(team.id);
+const project = projectsInTeam.find((project) => project.name === projectName);
+assert(project, `failed to get project "${projectName}"`);
+
+info`Fetching latest production deployment`;
+const productionDeployments = await client.deployments(team.id, project.id);
+const latestProductionDeployment = productionDeployments[0];
+assert(
+  latestProductionDeployment,
+  `failed to get latest production deployment`,
+);
+
+const response = await client.deployPreviewFrom(
+  team.id,
+  latestProductionDeployment.uid,
+  "rerun-custom-preview-test",
+  {
+    RELEASE_COMMIT: "main",
+  },
+);
+console.log(response);

.github/actions/deploy-vercel/util.mjs

@@ -1,5 +1,8 @@
 // @ts-check
 
+import { appendFileSync } from "fs";
+import os from "os";
+
 /**
  * Log a message with level `INFO`
  *
@@ -41,6 +44,16 @@ export function getRequiredInput(name) {
   return input;
 }
 
+/**
+ * Set a GitHub Actions output for other workflows steps to read.
+ * @param {string} key
+ * @param {string} value
+ */
+export function setOutput(key, value) {
+  const outputFile = /** @type {string} */ (process.env["GITHUB_OUTPUT"]);
+  appendFileSync(outputFile, `${key}=${value}${os.EOL}`);
+}
+
 /**
  * Assert that `value` is truthy, throwing an error if it is not.
  *
@@ -61,4 +74,3 @@ export function assert(value, message) {
     throw new Error(error);
   }
 }
-