@catladder/cli 0.0.0-next-89bce6d0 → 0.0.0-next-d13ff46d

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-next-89bce6d0",
+  "version": "0.0.0-next-d13ff46d",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

package/src/release/changesetsReleaseJob.ts

@@ -16,6 +16,7 @@ import {
   renderChangelogEntries,
 } from "./changesets";
 import { ensureReleaseHistory, getLastReleaseTag, git } from "./releaseGit";
+import { appendStepSummary } from "./stepSummary";
 
 const CHANGESET_DIR = ".changeset";
 const CHANGELOG_FILE = "CHANGELOG.md";
@@ -149,6 +150,10 @@ export const changesetsReleaseJob = async () => {
     console.log(
       "to release anyway (patch bump), run the force release job instead",
     );
+    appendStepSummary(
+      `ℹ️ **Nothing released** — no pending changesets in \`${CHANGESET_DIR}/\`. ` +
+        "Merge a changeset and release again, or force the release for a patch bump.",
+    );
     return;
   }
   const changesets = forcedEmpty ? [FORCED_RELEASE_CHANGESET] : pending;
@@ -194,6 +199,7 @@ export const changesetsReleaseJob = async () => {
   await git("tag", tag);
   await pushCommitAndTag(tag);
   console.log(`released ${tag}`);
+  appendStepSummary(`🚀 **Released ${tag}**\n\n${entries}`);
 
   if (process.env.GITHUB_ACTIONS === "true") {
     await dispatchTaggedReleaseWorkflow(tag);

package/src/release/githubQueuedRelease.ts

@@ -19,6 +19,7 @@
  */
 import { appendFileSync } from "fs";
 import { git } from "./releaseGit";
+import { appendStepSummary, workflowLink } from "./stepSummary";
 
 /**
  * the generated main-branch workflow whose runs gate a queued release.
@@ -27,6 +28,13 @@ import { git } from "./releaseGit";
  */
 const GITHUB_MAIN_WORKFLOW = "catladder-main.yml";
 
+/**
+ * the workflow that picks up a queued release, for summary links. Keep
+ * in sync with the release-on-green file name in
+ * pipeline/src/backends/github/GithubBackend.ts.
+ */
+const GITHUB_ON_GREEN_WORKFLOW = "catladder-release-on-green.yml";
+
 /**
  * where a queued release is recorded: a ref outside refs/heads and
  * refs/tags, pointing at the commit the release was queued for.
@@ -109,28 +117,43 @@ export const githubQueueCheckJob = async () => {
   const run = await getMainWorkflowRun(sha);
   if (!run) {
     console.log(`no main workflow run found for ${sha} — releasing right away`);
+    appendStepSummary(
+      `ℹ️ No main workflow run found for \`${sha}\` — releasing right away.`,
+    );
     setStepOutput("queued", "false");
     return;
   }
   if (run.status === "completed") {
     if (run.conclusion === "success") {
       console.log(`main workflow for ${sha} succeeded — releasing right away`);
+      appendStepSummary(
+        `✅ The main workflow for \`${sha}\` succeeded — releasing right away.`,
+      );
       setStepOutput("queued", "false");
       return;
     }
+    appendStepSummary(
+      `❌ Not releasing: the ${workflowLink(GITHUB_MAIN_WORKFLOW, "main workflow")} run for \`${sha}\` concluded **${run.conclusion}**. ` +
+        `Fix the pipeline, or re-run with the force checkbox to release anyway.`,
+    );
     fail(
       `the main workflow for ${sha} concluded '${run.conclusion}' — ` +
-        `fix the pipeline, or use the force-create-release task to release anyway`,
+        `fix the pipeline, or force the release to release anyway`,
     );
   }
   // queued / in_progress / waiting: record the intent and let the
   // release-on-green workflow do the release. Force-push: a re-queue
   // (or a stale marker of an older commit) just moves the marker.
   await git("push", "origin", `+${sha}:${QUEUE_MARKER_REF}`);
+  const runState = run.status.replace(/_/g, " ");
   console.log(
-    `main workflow for ${sha} is ${run.status} — release queued: ` +
+    `main workflow for ${sha} is ${runState} — release queued: ` +
       `the 'release on green' workflow creates the release as soon as the run succeeds`,
   );
+  appendStepSummary(
+    `⏳ **Release queued** for \`${sha}\` — the ${workflowLink(GITHUB_MAIN_WORKFLOW, "main workflow")} run is still ${runState}. ` +
+      `${workflowLink(GITHUB_ON_GREEN_WORKFLOW, "release on green")} creates the release as soon as it succeeds.`,
+  );
   setStepOutput("queued", "true");
 };
 
@@ -149,6 +172,7 @@ export const githubQueuedGuardJob = async (
   const marker = markerLine.split(/\s+/)[0] ?? "";
   if (!marker) {
     console.log("no release queued — nothing to do");
+    appendStepSummary("No release queued — nothing to do.");
     setStepOutput("release", "false");
     return;
   }
@@ -156,6 +180,9 @@ export const githubQueuedGuardJob = async (
     console.log(
       `queued release is for ${marker}, this run is for ${headSha} — leaving the queue untouched`,
     );
+    appendStepSummary(
+      `Queued release is for \`${marker}\`, this run is for \`${headSha}\` — leaving the queue untouched.`,
+    );
     setStepOutput("release", "false");
     return;
   }
@@ -163,11 +190,18 @@ export const githubQueuedGuardJob = async (
   // this run, whatever its outcome
   await git("push", "origin", `:${QUEUE_MARKER_REF}`);
   if (conclusion !== "success") {
+    appendStepSummary(
+      `❌ Queued release for \`${headSha}\` **not executed**: the main workflow concluded **${conclusion}**. ` +
+        `Fix the pipeline and queue again via the 🚀 create release workflow.`,
+    );
     fail(
       `queued release not executed: the main workflow concluded '${conclusion}' — ` +
-        `fix the pipeline and queue again (create-release task)`,
+        `fix the pipeline and queue the release again`,
     );
   }
   console.log(`main workflow for ${headSha} succeeded — releasing`);
+  appendStepSummary(
+    `✅ Main workflow for \`${headSha}\` succeeded — running the queued release.`,
+  );
   setStepOutput("release", "true");
 };

package/src/release/stepSummary.ts

@@ -0,0 +1,27 @@
+/**
+ * github step summaries: markdown shown on the run page, so a run
+ * explains what happened without reading job logs. No-op outside
+ * github actions (GITHUB_STEP_SUMMARY unset, e.g. on gitlab).
+ */
+import { appendFileSync } from "fs";
+
+export const appendStepSummary = (markdown: string) => {
+  const file = process.env.GITHUB_STEP_SUMMARY;
+  if (!file) {
+    return;
+  }
+  appendFileSync(file, markdown + "\n");
+};
+
+/**
+ * link to a generated workflow's run list (e.g.
+ * `workflowLink("catladder-main.yml", "catladder main")`)
+ */
+export const workflowLink = (fileName: string, label: string): string => {
+  const server = process.env.GITHUB_SERVER_URL ?? "https://github.com";
+  const repository = process.env.GITHUB_REPOSITORY;
+  if (!repository) {
+    return label;
+  }
+  return `[${label}](${server}/${repository}/actions/workflows/${fileName})`;
+};