[Docs Site] Move show-changed-files to bin and fix workflow condition

Author: KianNH

.github/actions/show-changed-files/package-lock.json

@@ -13,16 +13,15 @@ on:
 jobs:
   changed-files-links:
     name: Show Changed Files
-    if: github.event.issue.pull_request && github.event.issue.state == 'open' && github.event.comment.user.id == 41898282 && contains(github.event.comment.body, '**Preview URL**')
+    if: github.event.issue.pull_request && github.event.issue.state == 'open' && github.event.comment.user.id == 41898282 && contains(github.event.comment.body, '**Preview URL:**')
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - run: cd ./.github/actions/show-changed-files
       - uses: actions/setup-node@v4
         with:
           node-version: 22
           cache: "npm"
       - run: npm ci
-      - run: npx tsx index.ts
+      - run: npx tsx bin/show-changed-files/index.ts
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/actions/show-changed-files/package.json

@@ -0,0 +1,5 @@
+export const GITHUB_ACTIONS_BOT_ID = 41898282;
+export const DOCS_BASE_URL = "https://developers.cloudflare.com";
+export const CONTENT_BASE_PATH = "src/content";
+export const EXISTING_COMMENT_SUBSTRING = "| Original Link | Updated Link |";
+export const PREVIEW_URL_REGEX = /^\*\*Preview URL:\*\* (.*)$/m;

.github/actions/show-changed-files/tsconfig.json

@@ -0,0 +1,53 @@
+import { describe, expect, test } from "vitest";
+
+import { DOCS_BASE_URL, PREVIEW_URL_REGEX } from "./constants";
+import { filenameToPath } from "./util";
+
+test("PREVIEW_URL_REGEX", () => {
+	const comment =
+		"**Preview URL:** https://ac148943-cloudflare-docs.cloudflare-docs.workers.dev";
+	const matches = comment.match(PREVIEW_URL_REGEX);
+
+	expect(matches).toBeDefined();
+	expect(matches![1]).toEqual(
+		"https://ac148943-cloudflare-docs.cloudflare-docs.workers.dev",
+	);
+});
+
+describe("filenameToPath", () => {
+	test("index", () => {
+		expect(filenameToPath("src/content/docs/workers/index.mdx")).toEqual(
+			"workers/",
+		);
+	});
+
+	test("index base", () => {
+		expect(
+			`${DOCS_BASE_URL}/${filenameToPath("src/content/docs/workers/index.mdx")}`,
+		).toEqual("https://developers.cloudflare.com/workers/");
+	});
+
+	test("folder", () => {
+		expect(
+			filenameToPath("src/content/docs/workers/get-started/cli.mdx"),
+		).toEqual("workers/get-started/cli/");
+	});
+
+	test("1.1.1.1", () => {
+		expect(filenameToPath("src/content/docs/1111/index.mdx")).toEqual(
+			"1.1.1.1/",
+		);
+	});
+
+	test("changelog", () => {
+		expect(
+			filenameToPath("src/content/changelogs-next/2025-02-05-title.mdx"),
+		).toEqual("changelog/2025-02-05-title/");
+	});
+
+	test("changelog base", () => {
+		expect(
+			`${DOCS_BASE_URL}/${filenameToPath("src/content/changelogs-next/2025-02-05-title.mdx")}`,
+		).toEqual("https://developers.cloudflare.com/changelog/2025-02-05-title/");
+	});
+});

.github/workflows/show-changed-files.yml

@@ -1,18 +1,28 @@
 import * as core from "@actions/core";
 import * as github from "@actions/github";
 
-import { slug } from "github-slugger";
+import {
+	CONTENT_BASE_PATH,
+	DOCS_BASE_URL,
+	EXISTING_COMMENT_SUBSTRING,
+	GITHUB_ACTIONS_BOT_ID,
+	PREVIEW_URL_REGEX,
+} from "./constants";
 
-const GITHUB_ACTIONS_BOT_ID = 41898282;
-const DOCS_BASE_URL = "https://developers.cloudflare.com";
-const CONTENT_BASE_PATH = "src/content/docs/";
+import { filenameToPath } from "./util";
 
 async function run(): Promise<void> {
 	try {
 		const token = core.getInput("GITHUB_TOKEN", { required: true });
 		const octokit = github.getOctokit(token);
 
 		const ctx = github.context;
+
+		if (!ctx.payload.issue) {
+			core.setFailed(`Payload ${ctx.payload} is missing an 'issue' property`);
+			process.exit();
+		}
+
 		const issue = ctx.payload.issue.number;
 
 		const files = await octokit.paginate(octokit.rest.pulls.listFiles, {
@@ -30,63 +40,44 @@ async function run(): Promise<void> {
 
 		const existingComment = comments.find(
 			(comment) =>
-				comment.user.id === GITHUB_ACTIONS_BOT_ID &&
-				comment.body.includes("| Original Link | Updated Link |"),
+				comment.user?.id === GITHUB_ACTIONS_BOT_ID &&
+				comment.body?.includes(EXISTING_COMMENT_SUBSTRING),
 		);
 
 		const urlComment = comments.find(
 			(comment) =>
-				comment.user.id === GITHUB_ACTIONS_BOT_ID &&
-				comment.body.includes("**Preview URL:**"),
+				comment.user?.id === GITHUB_ACTIONS_BOT_ID &&
+				PREVIEW_URL_REGEX.test(comment.body ?? ""),
 		);
 
-		let previewUrl: string;
-
-		if (urlComment) {
-			if (!urlComment.body) {
-				core.setFailed(`${urlComment.id} has no body`);
-				process.exit();
-			}
-
-			const match = urlComment.body.match(/^\*\*Preview URL:\*\* (.*)$/m)[1];
+		if (!urlComment || !urlComment.body) {
+			core.setFailed(
+				`Could not find a comment from ${GITHUB_ACTIONS_BOT_ID} on ${issue}`,
+			);
+			process.exit();
+		}
 
-			if (!match) {
-				core.setFailed(`Could not extract URL from ${urlComment.body}`);
-				process.exit();
-			}
+		const match = urlComment.body.match(PREVIEW_URL_REGEX);
 
-			previewUrl = match;
+		if (!match) {
+			core.setFailed(`Could not extract URL from ${urlComment.body}`);
+			process.exit();
 		}
 
+		const previewUrl = match[1];
+
 		core.debug(previewUrl);
 
 		const changedFiles = files
 			.filter(
 				(file) =>
 					file.filename.endsWith(".mdx") &&
-					file.filename.startsWith(CONTENT_BASE_PATH),
+					(file.filename.startsWith(`${CONTENT_BASE_PATH}/docs/`) ||
+						file.filename.startsWith(`${CONTENT_BASE_PATH}/changelogs-next/`)),
 			)
 			.sort((a, b) => b.changes - a.changes)
 			.slice(0, 15) // Limit to 15 entries
 			.map(({ filename }) => {
-				const filenameToPath = (filename: string) => {
-					return filename
-						.replace(".mdx", "")
-						.split("/")
-						.map((segment, idx) => {
-							const slugified = slug(segment);
-
-							if (idx === 0 && slugified === "1111") {
-								return "1.1.1.1";
-							}
-
-							return slugified;
-						})
-						.join("/")
-						.replace(/\/index$/, "")
-						.concat("/");
-				};
-
 				const original = `${DOCS_BASE_URL}/${filenameToPath(filename)}`;
 				const preview = `${previewUrl}/${filenameToPath(filename)}`;
 
@@ -122,7 +113,9 @@ async function run(): Promise<void> {
 			});
 		}
 	} catch (error) {
-		core.setFailed(error.message);
+		if (error instanceof Error) {
+			core.setFailed(error.message);
+		}
 		process.exit();
 	}
 }

.github/actions/show-changed-files/readme.md renamed to bin/show-changed-files/README.md

@@ -0,0 +1,31 @@
+import { slug } from "github-slugger";
+
+import { CONTENT_BASE_PATH } from "./constants";
+
+export const filenameToPath = (filename: string) => {
+	return filename
+		.replace(CONTENT_BASE_PATH, "")
+		.replace(".mdx", "")
+		.split("/")
+		.filter(Boolean)
+		.flatMap((segment) => {
+			if (segment === "docs") {
+				return [];
+			}
+
+			if (segment === "changelogs-next") {
+				segment = "changelog";
+			}
+
+			const slugified = slug(segment);
+
+			if (slugified === "1111") {
+				return "1.1.1.1";
+			}
+
+			return slugified;
+		})
+		.join("/")
+		.replace(/\/index$/, "")
+		.concat("/");
+};

bin/show-changed-files/constants.ts

@@ -0,0 +1,3 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({});