Comment changeset status in PRs (#625)

* Initial implementation * Fix * fix * fix * Make it look nicer * Update docs * Rename to pr-status-comment * Remove outputs * Update path * update name * Checkout PR in a detached worktree (#626) Co-authored-by: bluwy <bjornlu.dev@gmail.com> * Move comment to separate job * Loosen event requirement * Update * Apply suggestions from code review Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com> * Use TLA * use using * Remove test log --------- Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-10-26 16:39:56 +08:00 · 2026-05-29 12:27:24 +00:00
parent 34f64f6e2e
commit 8795eee5ee
12 changed files with 599 additions and 2 deletions
@@ -0,0 +1,148 @@
+import { pathToFileURL } from "node:url";
+import type * as github from "@actions/github";
+import getReleasePlan from "@changesets/get-release-plan";
+import { createFixture } from "fs-fixture";
+import { exec } from "tinyexec";
+import { describe, expect, it } from "vitest";
+import { getPullRequestWorktree } from "./worktree.ts";
+
+type PullRequestContext = NonNullable<
+  typeof github.context.payload.pull_request
+>;
+
+async function git(cwd: string, args: string[]) {
+  const output = await exec("git", args, {
+    nodeOptions: { cwd },
+    throwOnError: true,
+  });
+  return output.stdout.trim();
+}
+
+describe("getPullRequestWorktree", () => {
+  it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
+    // Local source repo
+    await using sourceRepoFixture = await createFixture({
+      ".changeset/config.json": JSON.stringify({}),
+      "package.json": JSON.stringify({
+        name: "repo",
+        private: true,
+        workspaces: ["packages/*"],
+      }),
+      "packages/pkg-a/package.json": JSON.stringify({
+        name: "pkg-a",
+        version: "1.0.0",
+      }),
+    });
+    const sourceRepo = sourceRepoFixture.path;
+    await git(sourceRepo, ["init", "-b", "main"]);
+    await git(sourceRepo, ["config", "user.name", "Test User"]);
+    await git(sourceRepo, ["config", "user.email", "test@example.com"]);
+    await git(sourceRepo, ["add", "."]);
+    await git(sourceRepo, ["commit", "-m", "base"]);
+
+    // Simulate remote bare git server
+    await using originBareFixture = await createFixture();
+    const originBare = originBareFixture.path;
+    await git(originBare, ["clone", "--bare", sourceRepo, originBare]);
+
+    // Simulate checkout PR in github action
+    await using checkoutRepoFixture = await createFixture();
+    const checkoutRepo = checkoutRepoFixture.path;
+    await git(checkoutRepo, [
+      "clone",
+      "--depth",
+      "1",
+      "--branch",
+      "main",
+      pathToFileURL(originBare).toString(),
+      checkoutRepo,
+    ]);
+
+    // Simulate remote fork bare git server
+    await using forkBareFixture = await createFixture();
+    const forkBare = forkBareFixture.path;
+    await git(forkBare, ["clone", "--bare", originBare, forkBare]);
+
+    await using forkRepoFixture = await createFixture();
+    const forkRepo = forkRepoFixture.path;
+    await git(forkRepo, [
+      "clone",
+      "--depth",
+      "1",
+      "--branch",
+      "main",
+      pathToFileURL(forkBare).toString(),
+      forkRepo,
+    ]);
+    await git(forkRepo, ["config", "user.name", "Test User"]);
+    await git(forkRepo, ["config", "user.email", "test@example.com"]);
+    await git(forkRepo, ["checkout", "-b", "feature"]);
+
+    await forkRepoFixture.mkdir("packages/pkg-a/src");
+    await forkRepoFixture.writeFile(
+      "packages/pkg-a/src/index.ts",
+      "export const value = 1;\n",
+    );
+    await forkRepoFixture.writeFile(
+      ".changeset/add-pkg-a.md",
+      `\
+---
+"pkg-a": patch
+---
+
+Add pkg-a
+`,
+    );
+
+    await git(forkRepo, ["add", "."]);
+    await git(forkRepo, ["commit", "-m", "feature"]);
+    await git(forkRepo, ["push", "origin", "feature"]);
+
+    // Run tests
+    const originalHead = await git(checkoutRepo, ["rev-parse", "HEAD"]);
+    const context = {
+      number: 123,
+      base: {
+        ref: "main",
+        repo: {
+          clone_url: pathToFileURL(originBare).toString(),
+        },
+      },
+      head: {
+        ref: "feature",
+        repo: {
+          clone_url: pathToFileURL(forkBare).toString(),
+        },
+      },
+    };
+
+    await using worktree = await getPullRequestWorktree(
+      context satisfies PullRequestContext as PullRequestContext,
+      checkoutRepo,
+    );
+
+    const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
+
+    const currentHead = await git(worktree.cwd, ["rev-parse", "HEAD"]);
+    expect(currentHead).not.toBe(originalHead);
+
+    const currentBranch = await git(worktree.cwd, ["branch", "--show-current"]);
+    expect(currentBranch).toBe("");
+
+    const releases = releasePlan.releases.map((release) => ({
+      name: release.name,
+      type: release.type,
+      newVersion: release.newVersion,
+    }));
+    expect(releases).toEqual([
+      {
+        name: "pkg-a",
+        type: "patch",
+        newVersion: "1.0.1",
+      },
+    ]);
+
+    expect(await git(checkoutRepo, ["rev-parse", "HEAD"])).toBe(originalHead);
+    expect(await git(checkoutRepo, ["branch", "--show-current"])).toBe("main");
+  });
+});