update deploy scripts

Author: acolytec3

.github/workflows/deploy.yaml

@@ -1,59 +1,53 @@
-name: Deploy specification
+name: Deploy to GitHub Pages
 
 on:
   push:
     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
 
 env:
-  # this avoids node running out of memory while building
-  NODE_OPTIONS: --max_old_space_size=20480
-
+  cwd: ${{github.workspace}}/site
 jobs:
-  deploy-spec:
+  build:
+    name: Build Docusaurus
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 15
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm install --frozen-lockfile
+      - name: Build website
+        run: npm run build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          node-version: '15'
-      - run: npm ci
-      - run: npm run build
-      - name: setup git config
-        run: |
-          git config user.name "GitHub Actions Bot"
-          git config user.email "<>"
-      - name: Deploy assembled spec
-        run: |
-          git checkout -b assembled-spec
-          git add -f openrpc.json
-          git add -f refs-openrpc.json
-          git commit -m "assemble openrpc.json"
-          git push -fu origin assembled-spec
-  deploy-gh-pages:
+          path: build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    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 }}
+
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 15
-        uses: actions/setup-node@v1
-        with:
-          node-version: '15'
-      - run: npm ci
-      - run: npm run build
-      - run: npm run generate-clients
-      - run: 'sed -i -e "s|Prefix: \"\"|Prefix: \"/execution-apis\"|g" build/docs/gatsby/gatsby-config.js'
-      - run: 'sed -i -e "s|/api|api|g" build/docs/gatsby/src/pages/index.tsx'
-      - run: npm run build:docs
-      - name: setup git config
-        run: |
-          git config user.name "GitHub Actions Bot"
-          git config user.email "<>"
       - name: Deploy to GitHub Pages
-        if: success()
-        uses: crazy-max/ghaction-github-pages@v3
-        with:
-          target_branch: gh-pages
-          build_dir: build/docs/gatsby/public
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/deploy.yaml.old

@@ -0,0 +1,59 @@
+name: Deploy specification
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  # this avoids node running out of memory while building
+  NODE_OPTIONS: --max_old_space_size=20480
+
+jobs:
+  deploy-spec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 15
+        uses: actions/setup-node@v1
+        with:
+          node-version: '15'
+      - run: npm ci
+      - run: npm run build
+      - name: setup git config
+        run: |
+          git config user.name "GitHub Actions Bot"
+          git config user.email "<>"
+      - name: Deploy assembled spec
+        run: |
+          git checkout -b assembled-spec
+          git add -f openrpc.json
+          git add -f refs-openrpc.json
+          git commit -m "assemble openrpc.json"
+          git push -fu origin assembled-spec
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 15
+        uses: actions/setup-node@v1
+        with:
+          node-version: '15'
+      - run: npm ci
+      - run: npm run build
+      - run: npm run generate-clients
+      - run: 'sed -i -e "s|Prefix: \"\"|Prefix: \"/execution-apis\"|g" build/docs/gatsby/gatsby-config.js'
+      - run: 'sed -i -e "s|/api|api|g" build/docs/gatsby/src/pages/index.tsx'
+      - run: npm run build:docs
+      - name: setup git config
+        run: |
+          git config user.name "GitHub Actions Bot"
+          git config user.email "<>"
+      - name: Deploy to GitHub Pages
+        if: success()
+        uses: crazy-max/ghaction-github-pages@v3
+        with:
+          target_branch: gh-pages
+          build_dir: build/docs/gatsby/public
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

site/.nojekyll

@@ -17,8 +17,9 @@ const config: Config = {
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'ethereum', // Usually your GitHub org/user name.
+  organizationName: 'acolytec3', // Usually your GitHub org/user name.
   projectName: 'execution-apis', // Usually your repo name.
+  deploymentBranch: 'gh-pages',
 
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
@@ -37,12 +38,14 @@ const config: Config = {
       /** @type {import('@metamask/docusaurus-openrpc/dist/preset').Options} */
       {
         docs: {
+          id: 'execution-apis',
           routeBasePath: '/',
           openrpc: {
             openrpcDocument: '../refs-openrpc.json',
             path: 'Reference',
             sidebarLabel: 'JSON-RPC',
           },
+          path: '/',
           sidebarPath: './sidebars.ts',
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.