Move to WFP for preview deployments

Author: KianNH

.github/workflows/publish-preview.yml

@@ -32,11 +32,15 @@ jobs:
         name: Build
         env:
           NODE_OPTIONS: --max-old-space-size=4096
-      - run: npx wrangler versions upload
-        name: Deploy to Cloudflare Workers
+      - name: Deploy to Cloudflare Workers
         env:
           CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          WRANGLER_OUTPUT_FILE_PATH: wrangler-logs.ndjson
+        run: |
+          SHORT_SHA=$(git rev-parse --short=8 HEAD)
+          BRANCH_SLUG=$(git rev-parse --abbrev-ref HEAD | iconv -c -t ascii//TRANSLIT | sed -E 's/[~^]+//g' | sed -E 's/[^a-zA-Z0-9]+/-/g' | sed -E 's/^-+|-+$//g' | tr A-Z a-z)
+
+          npx wrangler deploy --dispatch-namespace preview-deployments --name $SHORT_SHA
+          npx wrangler deploy --dispatch-namespace preview-deployments --name $BRANCH_SLUG
       - name: Post preview URL on PR
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

bin/post-preview-url-comment/constants.ts

@@ -2,4 +2,3 @@ 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 PREVIEW_URL_REGEX = /^\*\*Preview URL:\*\* (.*)$/m;
-export const WRANGLER_LOGS_PATH = "wrangler-logs.ndjson";

bin/post-preview-url-comment/index.ts

@@ -1,22 +1,19 @@
 import * as core from "@actions/core";
 import * as github from "@actions/github";
 
-import { readFile } from "node:fs/promises";
-
 import {
 	CONTENT_BASE_PATH,
 	DOCS_BASE_URL,
 	GITHUB_ACTIONS_BOT_ID,
 	PREVIEW_URL_REGEX,
-	WRANGLER_LOGS_PATH,
 } from "./constants";
 
-import { filenameToPath } from "./util";
+import { filenameToPath, slug } from "./util";
 
 async function run(): Promise<void> {
 	try {
-		if (!process.env.GITHUB_TOKEN) {
-			core.setFailed(`Could not find GITHUB_TOKEN in env`);
+		if (!process.env.GITHUB_TOKEN || !process.env.GITHUB_REF_NAME) {
+			core.setFailed(`Could not find GITHUB_TOKEN or GITHUB_REF_NAME in env`);
 			process.exit();
 		}
 
@@ -53,22 +50,12 @@ async function run(): Promise<void> {
 				PREVIEW_URL_REGEX.test(comment.body ?? ""),
 		);
 
-		const previewUrl: string = (
-			await readFile(WRANGLER_LOGS_PATH, { encoding: "utf-8" })
-		)
-			.split("\n")
-			.filter(Boolean)
-			.map((json) => JSON.parse(json))
-			.filter((json) => json.type === "version-upload")
-			.map((json) => json.preview_url)
-			.at(0);
-
-		if (!previewUrl) {
-			core.setFailed(`Found no version-upload at ${WRANGLER_LOGS_PATH}`);
-			process.exit();
-		}
+		const previewUrl = {
+			branch: `https://${slug(process.env.GITHUB_REF_NAME)}.preview.developers.cloudflare.com`,
+			commit: `https://${ctx.sha.slice(0, 8)}.preview.developers.cloudflare.com`,
+		};
 
-		core.debug(previewUrl);
+		core.debug(JSON.stringify(previewUrl));
 
 		const changedFiles = files
 			.filter(
@@ -81,14 +68,14 @@ async function run(): Promise<void> {
 			.slice(0, 15) // Limit to 15 entries
 			.map(({ filename }) => {
 				const original = `${DOCS_BASE_URL}/${filenameToPath(filename)}`;
-				const preview = `${previewUrl}/${filenameToPath(filename)}`;
+				const preview = `${previewUrl.branch}/${filenameToPath(filename)}`;
 
 				core.debug([filename, original, preview].toString());
 
 				return { original, preview };
 			});
 
-		let comment = `**Preview URL:** ${previewUrl}`;
+		let comment = `**Preview URL:** ${previewUrl.branch}`;
 		if (changedFiles.length !== 0) {
 			comment = comment.concat(
 				`**Files with changes (up to 15)**\n\n| Original Link | Updated Link |\n| --- | --- |\n${changedFiles

bin/post-preview-url-comment/util.ts

@@ -29,3 +29,5 @@ export const filenameToPath = (filename: string) => {
 		.replace(/\/index$/, "")
 		.concat("/");
 };
+
+export { slug };