@catladder/cli 5.3.0 → 5.3.2

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "5.3.0",
+  "version": "5.3.2",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

package/src/release/__tests__/changesetCheckJob.test.ts

@@ -0,0 +1,68 @@
+import { mkdtemp, readFile, rm } from "fs/promises";
+import { tmpdir } from "os";
+import { join } from "path";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { CHANGESET_REPORT_FILE, changesetCheckJob } from "../changesetCheckJob";
+
+// the merge request's diff against its target branch: the only git
+// output the check parses
+const gitMock = vi.hoisted(() => ({ addedFiles: [] as string[] }));
+
+vi.mock("../releaseGit", () => ({
+  ensureReleaseHistory: vi.fn(async () => undefined),
+  getLastReleaseTag: vi.fn(async () => "v1.2.3"),
+  git: vi.fn(async (command: string) =>
+    command === "diff" ? gitMock.addedFiles.join("\n") : "",
+  ),
+}));
+
+vi.mock("../changesetsReleaseJob", () => ({
+  readPendingChangesets: vi.fn(async () => []),
+}));
+
+let cwd: string;
+let workDir: string;
+
+beforeEach(async () => {
+  cwd = process.cwd();
+  workDir = await mkdtemp(join(tmpdir(), "changeset-check-"));
+  process.chdir(workDir);
+  process.exitCode = undefined;
+  vi.spyOn(console, "log").mockImplementation(() => undefined);
+  vi.stubEnv("GITHUB_ACTIONS", undefined as any);
+  vi.stubEnv("GL_TOKEN", undefined as any);
+  vi.stubEnv("CI_MERGE_REQUEST_TARGET_BRANCH_NAME", "main");
+});
+
+afterEach(async () => {
+  process.chdir(cwd);
+  process.exitCode = undefined;
+  vi.unstubAllEnvs();
+  vi.restoreAllMocks();
+  await rm(workDir, { recursive: true, force: true });
+});
+
+describe("changesetCheckJob on gitlab", () => {
+  it("exits 0 when the merge request adds no changeset — a failed job would never resolve its exposed report", async () => {
+    gitMock.addedFiles = ["src/index.ts"];
+
+    await changesetCheckJob();
+
+    expect(process.exitCode).toBeUndefined();
+    const report = await readFile(CHANGESET_REPORT_FILE, "utf-8");
+    expect(report).toContain("adds no changeset");
+    expect(console.log).toHaveBeenCalledWith(
+      expect.stringContaining("⚠️  this merge request adds no changeset"),
+    );
+  });
+
+  it("exits 0 and reports the changesets the merge request adds", async () => {
+    gitMock.addedFiles = [".changeset/brave-cats.md"];
+
+    await changesetCheckJob();
+
+    expect(process.exitCode).toBeUndefined();
+    const report = await readFile(CHANGESET_REPORT_FILE, "utf-8");
+    expect(report).toContain("adds 1 changeset: `brave-cats.md`");
+  });
+});

package/src/release/changesetCheckJob.ts

@@ -4,8 +4,9 @@
  * reports which changesets the merge request adds, what is pending and
  * what version merging would release. The report goes to the job log,
  * to `changeset-report.md` (exposed as an artifact on gitlab) and to a
- * sticky MR/PR comment where a token allows it. Exits 1 (the job runs
- * with allow_failure) when the merge request adds no changeset.
+ * sticky MR/PR comment where a token allows it. Always exits 0: a
+ * missing changeset is a warning carried by the report, not a job
+ * failure (see the end of {@link changesetCheckJob}).
  */
 import { existsSync } from "fs";
 import { writeFile } from "fs/promises";
@@ -203,11 +204,17 @@ export const changesetCheckJob = async () => {
     return;
   }
   if (!result.addsChangeset) {
+    // the job stays green on both platforms — the report, the log and
+    // the sticky comment carry the "no changeset" warning instead:
+    // - github has no "warning" job state: exiting non-zero would show
+    //   the job as failed (a red ❌ and "exit code 1"), which reads
+    //   like something broke.
+    // - gitlab only resolves the exposed artifact (the MR widget's
+    //   "changeset report" link) of a SUCCESSFUL job: for a failed
+    //   allow_failure job `exposed_artifacts.json` answers 204 forever
+    //   and the widget spins on "Loading artifacts" — exactly on the
+    //   MRs that need the report.
     if (onGithub()) {
-      // github has no "warning" job state: exiting non-zero would show
-      // the job as failed (a red ❌ and "exit code 1"), which reads like
-      // something broke. A warning annotation plus the step summary and
-      // the sticky PR comment carry the signal instead.
       console.log(
         "::warning title=No changeset::this pull request adds no changeset — " +
           "if the change is user-facing, add one so it appears in the next release's changelog",
@@ -215,10 +222,11 @@ export const changesetCheckJob = async () => {
       appendStepSummary(
         result.markdown.replace(`${CHANGESET_CHECK_MARKER}\n`, ""),
       );
-      return;
+    } else {
+      console.log(
+        "⚠️  this merge request adds no changeset — if the change is user-facing, " +
+          "add one so it appears in the next release's changelog (see the changeset report)",
+      );
     }
-    // gitlab: exit 1 turns the (allow_failure) job yellow so reviewers
-    // notice
-    process.exitCode = 1;
   }
 };