feat: add changelog system

This implements a new changelog system to the docs so it's easy to
browse it and subscribe via RSS.

Fixes MRGFY-5981

Change-Id: Ia2551cf70a6317a02376c287da41230680a05be4

Author: jd

eslint.config.js

@@ -16,6 +16,7 @@ export default [
       'node_modules/**',
       '.github/**',
       'public/scalar-api-reference.js',
+      'src/content/changelog/',
     ],
   },
 

package-lock.json

@@ -65,6 +65,7 @@
   "dependencies": {
     "@astrojs/check": "^0.9.5",
     "@astrojs/react": "^4.4.0",
+    "@astrojs/rss": "^4.0.12",
     "@astrojs/vue": "^5.1.1",
     "@fontsource/ibm-plex-mono": "^5.2.7",
     "@fontsource/poppins": "^5.2.7",

package.json

@@ -40,6 +40,18 @@ for (const [p, t] of trails.entries()) {
   }
 }
 
+// Handle dynamic changelog entries
+if (currentPath.startsWith('/changelog/') && currentPath !== '/changelog') {
+  // This is a specific changelog entry page
+  matchedTrail = [{ title: 'Changelog', path: '/changelog' }];
+
+  // Add the current page title from props if available
+  const { breadcrumbTitle } = Astro.props as { breadcrumbTitle?: string };
+  if (breadcrumbTitle) {
+    matchedTrail.push({ title: breadcrumbTitle });
+  }
+}
+
 if (matchedTrail.length >= 2) {
   const filtered: TrailEntry[] = [];
   for (const entry of matchedTrail) {

src/@types/changelog-content.d.ts

@@ -84,7 +84,7 @@ export const helpCategory: Category = {
     },
     {
       text: 'Changelog',
-      href: 'https://changelog.mergify.com/',
+      href: 'https://docs.mergify.com/changelog/',
     },
     {
       text: 'Terms of Service',

src/components/Breadcrumbs.astro

@@ -87,8 +87,8 @@ import ThemeToggleButton from './ThemeToggleButton';
 			<HeaderLink href="https://slack.mergify.com" icon={SiSlack}>Slack Community</HeaderLink>
 			<HeaderLink href="https://github.com/Mergifyio/mergify/discussions" icon={FaGithub}>
 				Discussions
-			</HeaderLink>
-			<HeaderLink href="https://changelog.mergify.com" icon={HiOutlineDocumentArrowUp}>
+		        </HeaderLink>
+			<HeaderLink href="/changelog/" icon={HiOutlineDocumentArrowUp}  >
 				Changelog
 			</HeaderLink>
 			<HeaderLink href="https://status.mergify.com" icon={SiStatuspage}>Status</HeaderLink>

src/components/Footer/footer.ts

@@ -3,7 +3,7 @@ import { defineCollection, z } from 'astro:content';
 import { glob } from 'astro/loaders';
 
 const docs = defineCollection({
-  /* ... */
+  /* Documentation pages */
   loader: glob({
     pattern: '**/[^_]*.mdx',
     base: './src/content/docs',
@@ -16,4 +16,14 @@ const docs = defineCollection({
   }),
 });
 
-export const collections = { docs };
+const changelog = defineCollection({
+  type: 'content',
+  schema: z.object({
+    title: z.string(),
+    date: z.date(),
+    description: z.string().optional(),
+    tags: z.array(z.string()).default([]),
+  }),
+});
+
+export const collections = { docs, changelog };

src/components/Header/Header.astro

@@ -0,0 +1,9 @@
+---
+title: New option batch_max_wait_time
+date: 2022-01-05
+tags:
+  - Merge Queue
+description: "Add the new option `batch_max_wait_time` for queue."
+---
+
+Add the new option [`batch_max_wait_time`](https://docs.mergify.com/actions/queue/#queue-rules) for queue.

src/content.config.ts

@@ -0,0 +1,10 @@
+---
+title: batch_max_wait_time defaults to 30s
+date: 2022-01-06
+tags:
+  - Merge Queue
+  - Workflow Automation
+description: "Change the default value for `batch_max_wait_time` to `30s`."
+---
+
+Change the default value for `batch_max_wait_time` to `30s`.