ci: enhance docs workflow

tmc · Feb 9, 2025 · e2b71a4 · e2b71a4
1 parent 0672790
commit e2b71a4
Show file tree

Hide file tree

Showing 6 changed files with 20,692 additions and 13,446 deletions.
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
@@ -1,9 +1,20 @@
 name: Deploy to GitHub Pages
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
+      - docs-test
+    paths:
+      - 'docs/**'
+      - '.github/workflows/publish-docs.yaml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/publish-docs.yaml'
 
 permissions:
   contents: read
@@ -15,35 +26,58 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+  # Build job
+  build:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: yarn
-          cache-dependency-path: 'docs/package-lock.json'
+          cache: npm
+          cache-dependency-path: docs/package-lock.json
 
       - name: Install dependencies
-        working-directory: docs
-        run: yarn install --frozen-lockfile
-      - name: Build website
-        working-directory: docs
-        run: yarn build
+        run: npm ci
+
+      - name: Test build
+        run: |
+          npm run build
+
+      - name: Upload pages artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: github-pages-build
+          path: docs/build/*
+
+  # Deploy job
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: ${{ github.ref == 'refs/heads/main' && 'github-pages' || 'preview' }}
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Clean deployment directory
+        run: rm -rf artifact && mkdir artifact
+
+      - name: Download build
+        uses: actions/download-artifact@v4
+        with:
+          name: github-pages-build
+          path: artifact
 
       - name: Setup Pages
         uses: actions/configure-pages@v3
-      - name: Upload artifact
+
+      - name: Upload pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          # Upload entire repository
-          path: 'docs/build'
+          path: artifact
+
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v3
diff --git a/docs/docs/modules/agents/executor/index.mdx b/docs/docs/modules/agents/executor/index.mdx
@@ -5,6 +5,7 @@ sidebar_position: 2
 
 import CodeBlock from "@theme/CodeBlock";
 import Example from "@examples/mrkl-agent-example/mrkl_agent.go";
+import DocCardList from "@theme/DocCardList";
 
 # Agent Executors
 
@@ -18,5 +19,4 @@ To make agents more powerful we need to make them iterative, ie. call the model
 An example that initialize a MRKL (Modular Reasoning, Knowledge and Language, pronounced "miracle") agent executor.
 <CodeBlock language="go">{Example}</CodeBlock>
 
-import DocCardList from "@theme/DocCardList";
 <DocCardList />
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -5,6 +5,8 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 const { ProvidePlugin } = require("webpack");
 const path = require("path");
+const lightCodeTheme = require('prism-react-renderer').themes.github;
+const darkCodeTheme = require('prism-react-renderer').themes.dracula;
 
 const examplesPath = path.resolve(__dirname, "..", "examples");
 
@@ -124,8 +126,8 @@ const config = {
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
       prism: {
-        theme: require("prism-react-renderer/themes/vsLight"),
-        darkTheme: require("prism-react-renderer/themes/vsDark"),
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
       },
       image: "img/parrot-chainlink-icon.png",
       navbar: {