Add deployment preview to PRs

.github/workflows/deploy.yaml

@@ -6,48 +6,30 @@ on:
       - main
   workflow_dispatch:
 
-jobs:
-  build:
-    name: Build Docusaurus
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: npm
+env:
+  NODE_OPTIONS: --max_old_space_size=20480
+  GITHUB_REPOSITORY: ${{ github.repository }}
 
-      - name: Install dependencies
-        run: npm install --frozen-lockfile
-
-      - name: Build specs and website
-        run: |
-          npm run build
-          npm run build:docs
-
-      - name: Upload Build Artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: build
-
-  deploy:
-    name: Deploy to GitHub Pages
-    needs: build
-
-    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+jobs:
+  deploy-gh-pages:
     permissions:
-      pages: write # to deploy to Pages
-      id-token: write # to verify the deployment originates from an appropriate source
-
-    # Deploy to the github-pages environment
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+      pages: write
+      id-token: write
+      contents: write
 
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+      - run: npm ci
+      - run: npm run build
+      - run: npm run build:docs
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build/docs/gatsby/public
+          commit_message: "Deploy to GitHub Pages"

.github/workflows/test-deploy.yaml

@@ -2,14 +2,16 @@ name: Test deployment
 
 on:
   pull_request:
-    branches:
-      - main
-    # Review gh actions docs if you want to further define triggers, paths, etc
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
   workflow_dispatch:
 
 jobs:
-  test-deploy:
+  test-deploy:    
+    permissions:
+      pages: write
+      id-token: write
+      contents: write
+      pull-requests: write
+
     name: Test deployment
     runs-on: ubuntu-latest
     steps:
@@ -26,4 +28,11 @@ jobs:
       - name: Test build website
         run: |
           npm run build
-          npm run build:docs
+          npm run build:docs
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build/docs/gatsby/public
+          destination_dir: preview/pr-${{ github.event.number }}
+          force_orphan: true

.github/workflows/test.yaml

@@ -6,11 +6,11 @@ jobs:
   lint-and-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 15.x
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
         with:
-          node-version: ^15.x
+          node-version: 22
       - run: npm ci
       - run: npm run build
       - run: npm run lint

.gitignore

@@ -7,4 +7,3 @@ data.json
 schema.json
 *.dic
 .idea/
-.docusaurus

docs/config/gatsby-config.js

@@ -0,0 +1,100 @@
+const fs = require('fs');
+const path = require('path');
+
+// Function to get markdown files and create menu links
+function getMenuLinksFromDocs() {
+  const docsPath = path.join(__dirname, 'src/docs');
+  const menuLinks = [];
+
+  try {
+    const files = fs.readdirSync(docsPath);
+    files.forEach(file => {
+      if (file.endsWith('.md') || file.endsWith('.mdx')) {
+        const name = file.replace(/\.(md|mdx)$/, '').replace(/-/g, ' ');
+        const link = `/${file.replace(/\.(md|mdx)$/, '')}`;
+        menuLinks.push({
+          name: name.charAt(0).toUpperCase() + name.slice(1),
+          link: link
+        });
+      }
+    });
+  } catch (error) {
+    console.warn('Could not read docs directory:', error.message);
+  }
+
+  return menuLinks;
+}
+
+module.exports = {
+  pathPrefix: "/execution-apis",
+  siteMetadata: {
+    title: 'Ethereum JSON-RPC Specification',
+    description: 'A specification of the standard interface for Ethereum clients.',
+    siteUrl: process.env.GITHUB_REPOSITORY 
+      ? `https://${process.env.GITHUB_REPOSITORY.split('/')[0]}.github.io/execution-apis`
+      : 'https://ethereum.github.io/execution-apis', // fallback for local development
+    logoUrl: 'https://raw.githubusercontent.com/open-rpc/design/master/icons/open-rpc-logo-noText/open-rpc-logo-noText%20(PNG)/256x256.png',
+    primaryColor: '#3f51b5', //material-ui primary color
+    secondaryColor: '#f50057', //material-ui secondary color
+    author: '',
+    menuLinks: [
+      {
+        name: 'API Documentation',
+        link: '/api-documentation'
+      },
+      ...getMenuLinksFromDocs() // This will add all markdown files
+    ],
+    footerLinks: [
+      {
+        name: 'OpenRPC',
+        link: 'https://open-rpc.org'
+      }
+    ]
+  },
+  plugins: [
+   {
+      resolve: 'gatsby-plugin-mdx',
+      options: {
+        extensions: ['.mdx', '.md'],
+        gatsbyRemarkPlugins: [
+          {
+            resolve: 'gatsby-remark-autolink-headers',
+            options: {
+              icon: false,
+            },
+          },
+        ],
+      },
+    },
+    "gatsby-openrpc-theme",
+    {
+      resolve: 'gatsby-plugin-manifest',
+      options: {
+        name: 'pristine-site',
+        short_name: 'pristine-site',
+        start_url: '/execution-apis/',
+        background_color: 'transparent',
+        theme_color: '#3f51b5',
+        display: 'minimal-ui',
+        icon: 'src/images/gatsby-icon.png', // This path is relative to the root of the site.
+      },
+    },
+    "gatsby-plugin-image",
+    "gatsby-plugin-sharp",
+    "gatsby-transformer-sharp",
+    {
+      resolve: "gatsby-source-filesystem",
+      options: {
+        name: "images",
+        path: __dirname + '/src/images',
+      },
+    },
+    {
+      resolve: "gatsby-source-filesystem",
+      options: {
+        name: "docs",
+        path: __dirname + '/src/docs',
+      },
+    },
+  ],
+}

docs/reference/making-changes.md

@@ -115,4 +115,4 @@ others don't.
 
 [exec-apis]: https://github.com/ethereum/execution-apis
 [pm]: https://github.com/ethereum/pm
-[test-gen]: https://github.com/ethereum/execution-apis/blob/main/tests/README.md
+[test-gen]: https://github.com/ethereum/execution-apis/blob/main/tests/README.md