migrate changelogs

Author: KianNH

astro.config.ts

@@ -8,14 +8,15 @@ import starlightLinksValidator from "starlight-links-validator";
 import icon from "astro-icon";
 import sitemap from "@astrojs/sitemap";
 import react from "@astrojs/react";
-import { readdir } from "fs/promises";
+
+import { readdir } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
 
 import rehypeTitleFigure from "rehype-title-figure";
 import rehypeMermaid from "./src/plugins/rehype/mermaid.ts";
 import rehypeAutolinkHeadings from "./src/plugins/rehype/autolink-headings.ts";
 import rehypeExternalLinks from "./src/plugins/rehype/external-links.ts";
 import rehypeHeadingSlugs from "./src/plugins/rehype/heading-slugs.ts";
-import { fileURLToPath } from "url";
 
 async function autogenSections() {
 	const sections = (

bin/migrate-changelogs.ts

@@ -0,0 +1,86 @@
+import dedent from "dedent";
+import {
+	readFile,
+	readdir,
+	mkdir,
+	writeFile,
+	access,
+	constants,
+} from "fs/promises";
+import { parse, stringify } from "yaml";
+import { slug } from "github-slugger";
+
+const files = await readdir("./src/content/changelogs/", {
+	withFileTypes: true,
+});
+
+for (const file of files) {
+	const withoutExt = file.name.split(".")[0];
+
+	const content = await readFile(file.parentPath.concat(file.name), {
+		encoding: "utf-8",
+	});
+
+	const { productName, productLink, productArea, entries } = parse(content);
+
+	const productFile = "./src/content/products/".concat(file.name);
+	try {
+		await access(productFile, constants.F_OK);
+	} catch {
+		const productYaml = stringify({
+			name: productName,
+			product: {
+				title: productName,
+				url: productLink,
+				group: productArea,
+			},
+		});
+
+		await writeFile(productFile, productYaml, { encoding: "utf-8" });
+	}
+
+	for (const entry of entries) {
+		if (!entry.description) {
+			continue;
+		}
+
+		const title = entry.title ?? `Changelog for ${entry.publish_date}`;
+		const description =
+			entry.title ?? ` ${productName} changelog for ${entry.publish_date}`;
+		const date = new Date(entry.publish_date).toISOString();
+		const products = [withoutExt];
+
+		const frontmatter = {
+			title,
+			description,
+			date,
+			products,
+		};
+
+		const body = entry.description;
+
+		const content = dedent`
+		---
+		${stringify(frontmatter, { lineWidth: 0 }).trim()}
+		---
+
+		${body}
+		`;
+
+		const folder = `./src/content/changelogs-next/${withoutExt}/`;
+
+		await mkdir(folder, {
+			recursive: true,
+		});
+
+		let path = folder.concat(date.slice(0, 10));
+
+		if (entry.title) {
+			path = path.concat(`-${slug(entry.title)}`);
+		}
+
+		path = path.concat(".mdx");
+
+		await writeFile(path, content, { encoding: "utf-8" });
+	}
+}

public/_redirects

@@ -5,6 +5,18 @@
 /tutorials/ /search/?content_type%5B0%5D=Tutorial 301
 /sitemap.xml /sitemap-index.xml
 
+# changelogs
+
+## areas
+/cloudflare-one/changelog/index.xml /changelog-next/rss/index.xml 301
+/fundamentals/reference/changelog/performance/index.xml changelog-next/rss/index.xml 301
+/fundamentals/reference/changelog/platform/index.xml changelog-next/rss/index.xml 301
+/fundamentals/reference/changelog/security/index.xml changelog-next/rss/index.xml 301
+/workers/platform/changelog/platform/index.xml /changelog-next/rss/index.xml 301
+
+## products
+/cloudflare-one/changelog/access/index.xml /changelog-next/rss/access.xml 301
+
 # 1dot1_redirect
 /1.1.1.1/1.1.1.1-for-families/ /1.1.1.1/setup/ 301
 /1.1.1.1/1.1.1.1-for-families/android/ /1.1.1.1/setup/android/ 301

src/components/ProductChangelog.astro

@@ -1,133 +1,36 @@
----
-import { getEntry, type CollectionEntry } from "astro:content";
-import { marked } from "marked";
+<!-- ---
 import { getChangelogs } from "~/util/changelogs";
-import AnchorHeading from "~/components/AnchorHeading.astro";
-import { entryToString } from "~/util/container";
+import { getEntry } from "astro:content";
 
 const page = await getEntry("docs", Astro.params.slug!);
 
 if (!page) {
 	throw new Error(
-		`[ProductChangelog] Failed to find entry for ${Astro.params.slug}.`,
+		`[ProductChangelog] Unable to find entry for ${Astro.params.slug}`,
 	);
 }
 
-if (!page.data.changelog_file_name && !page.data.changelog_product_area_name) {
-	throw new Error(
-		`[ProductChangelog] ${Astro.params.slug} does not have a 'changelog_file_name' or 'changaelog_product_area_name' frontmatter property.`,
-	);
-}
+const { changelog } = page.data;
 
-if (page.data.changelog_file_name && page.data.changelog_file_name.length > 1) {
+if (!changelog || !changelog.products) {
 	throw new Error(
-		`[ProductChangelog] This component cannot be used on files that have more than 1 entry in their 'changelog_file_name' frontmatter property.`,
+		`[ProductChangelog] ${Astro.params.slug} must have a "changelog" entry in frontmatter`,
 	);
 }
 
-const name =
-	page.data.changelog_product_area_name ?? page.data.changelog_file_name?.[0];
-
-let changelogs;
-
-if (page.data.changelog_product_area_name) {
-	const opts = {
-		filter: (entry: CollectionEntry<"changelogs">) => {
-			return entry.data.productArea === name;
-		},
-	};
-	({ changelogs } = await getChangelogs(opts));
-} else {
-	if (name === "wrangler") {
-		const opts = {
-			wranglerOnly: true,
-		};
-		({ changelogs } = await getChangelogs(opts));
-	} else if (name === "api-deprecations") {
-		const opts = {
-			deprecationsOnly: true,
-		};
-		({ changelogs } = await getChangelogs(opts));
-	} else {
-		const opts = {
-			filter: (entry: CollectionEntry<"changelogs">) => {
-				return entry.id === name;
-			},
-		};
-		({ changelogs } = await getChangelogs(opts));
-	}
-}
-
-if (!changelogs) {
-	throw new Error(
-		`[ProductChangelog] Failed to find changelog called ${name}.`,
-	);
-}
+const changelogs = await getChangelogs({
+	filter: (e) => {
+		return e.data.products.some((p) =>
+			changelog.products?.some((v) => v.id === p.id),
+		);
+	},
+});
 ---
 
 {
-	page.data.pcx_content_type === "changelog" && (
-		<p>
-			<a href={`/${page.id}/index.xml`} target="_blank">
-				Subscribe to RSS
-			</a>
-		</p>
-	)
-}
-{
-	changelogs.map(([date, entries]) => (
-		<div data-date={date}>
-			{(entries ?? []).map(async (entry) => {
-				let description;
-				if (entry.individual_page) {
-					const link = entry.individual_page;
-
-					if (!link)
-						throw new Error(
-							`Changelog entry points to individual page but no link is provided`,
-						);
-
-					const page = await getEntry("docs", link.slice(1, -1));
-
-					if (!page)
-						throw new Error(
-							`Changelog entry points to ${link.slice(1, -1)} but unable to find entry with that slug`,
-						);
-
-					description = (await entryToString(page, Astro.locals)) ?? page.body;
-
-					return (
-						<div data-product={entry.product.toLowerCase()}>
-							<a href={entry.individual_page} class="no-underline">
-								<AnchorHeading depth={2} title={page.data.title} />
-							</a>
-							<p class="text-xs">{entry.date}</p>
-							{page.data.changelog_product_area_name && (
-								<h3 class="!mt-4">
-									<a href={entry.productLink}>{entry.product}</a>
-								</h3>
-							)}
-							{<Fragment set:html={description} />}
-						</div>
-					);
-				} else {
-					description = marked.parse(entry.description as string);
-					return (
-						<>
-							<AnchorHeading depth={2} title={date} />
-							<div data-product={entry.product.toLowerCase()}>
-								{page.data.changelog_product_area_name && (
-									<h3 class="!mt-4">
-										<a href={entry.productLink}>{entry.product}</a>
-									</h3>
-								)}
-								{entry.title && <strong>{entry.title}</strong>}
-								{<Fragment set:html={description} />}
-							</div>
-						</>
-					);
-				}
-			})}
-		</div>
+	changelogs.map((entry) => (
+		<h3>{entry.data.date.toISOString().slice(0, 10)}</h3>
+		<h4>{entry.data.description}</h4>
+		<p>For more information, refer to the <a href={entry.data.link}>dedicated changelog post</a>.</p>
 	))
-}
+} -->

src/content.config.ts

@@ -31,7 +31,7 @@ function contentLoader(name: string) {
 
 function dataLoader(name: string) {
 	return glob({
-		pattern: "**/*.(json|yml|yaml)",
+		pattern: "**/*.(json|yaml)",
 		base: "./src/content/" + name,
 	});
 }

src/content/docs/ai-gateway/changelog.mdx

@@ -1,10 +1,11 @@
 ---
 pcx_content_type: changelog
 title: Changelog
-changelog_file_name:
-  - ai-gateway
 sidebar:
   order: 9
+changelog:
+  products:
+    - changelog_file_name
 ---
 
 import { ProductChangelog } from "~/components";

src/content/docs/ddos-protection/change-log/http/scheduled-changes.mdx

@@ -6,7 +6,8 @@ sidebar:
 head:
   - tag: title
     content: Scheduled changes — HTTP DDoS
-
+changelog:
+  date: 2024-04-29
 ---
 
 import { RuleID } from "~/components"

src/content/docs/ddos-protection/change-log/network/scheduled-changes.mdx

@@ -6,7 +6,8 @@ sidebar:
 head:
   - tag: title
     content: Scheduled changes — Network-layer DDoS
-
+changelog:
+  date: 2024-10-10
 ---
 
 

src/content/docs/waf/change-log/historical-2018.mdx

@@ -7,6 +7,8 @@ head: []
 description: Changes to WAF managed rulesets done in 2018, before the public
   changelog was available.
 tableOfContents: false
+changelog:
+  date: 2018-12-31
 ---
 
 <table style="width: 100%">

src/content/docs/waf/change-log/historical-2019.mdx

@@ -6,6 +6,8 @@ sidebar:
 head: []
 description: Changes to WAF managed rulesets done in 2019.
 tableOfContents: false
+changelog:
+  date: 2019-12-31
 ---
 
 <table style="width: 100%">