Add changelog support to documentation using Starlight Changelogs plugin

.github/workflows/docs.yml

@@ -45,6 +45,8 @@ jobs:
 
       - name: Build documentation
         working-directory: ./docs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npm run build
 
       - name: Upload build artifacts

docs/astro.config.mjs

@@ -4,6 +4,7 @@ import starlight from '@astrojs/starlight';
 import starlightLlmsTxt from 'starlight-llms-txt';
 import starlightLinksValidator from 'starlight-links-validator';
 import starlightGitHubAlerts from 'starlight-github-alerts';
+import starlightChangelogs, { makeChangelogsSidebarLinks } from 'starlight-changelogs';
 
 // https://astro.build/config
 export default defineConfig({
@@ -14,6 +15,7 @@ export default defineConfig({
 			title: 'GitHub Agentic Workflows',
 			social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/githubnext/gh-aw' }],
 			plugins: [
+				starlightChangelogs(),
 				starlightGitHubAlerts(),
 				starlightLinksValidator({
 					errorOnRelativeLinks: true,
@@ -56,6 +58,9 @@ export default defineConfig({
 					label: 'Application Areas',
 					autogenerate: { directory: 'samples' },
 				},
+				...makeChangelogsSidebarLinks([
+					{ type: 'all', base: 'changelog', label: 'Changelog' }
+				]),
 			],
 		}),
 	],

docs/package.json

@@ -14,6 +14,7 @@
     "@astrojs/starlight": "^0.35.2",
     "astro": "^5.6.1",
     "sharp": "^0.34.2",
+    "starlight-changelogs": "^0.2.1",
     "starlight-links-validator": "^0.17.2",
     "starlight-llms-txt": "^0.6.0"
   },

docs/src/content.config.ts

@@ -1,7 +1,21 @@
 import { defineCollection } from 'astro:content';
 import { docsLoader } from '@astrojs/starlight/loaders';
 import { docsSchema } from '@astrojs/starlight/schema';
+import { changelogsLoader } from 'starlight-changelogs/loader';
 
 export const collections = {
 	docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+	changelogs: defineCollection({
+		loader: changelogsLoader([
+			{
+				provider: 'github',       // use GitHub releases as changelog source
+				base: 'changelog',        // base path for changelog pages
+				owner: 'githubnext',      // GitHub org/user
+				repo: 'gh-aw',            // GitHub repo
+				// Use GitHub token if available in environment, otherwise rely on public API
+				...(process.env.GITHUB_TOKEN && { token: process.env.GITHUB_TOKEN }),
+				// No process filter: include all releases
+			},
+		]),
+	}),
 };