ci: deploy to github pages

Author: andrewalderson

.devcontainer/devcontainer.json

@@ -6,7 +6,11 @@
   "image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm",
 
   // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
+  "features": {
+    // Needed for Github Local Actions extension
+    "ghcr.io/devcontainers-extra/features/act:1": { },
+    "ghcr.io/devcontainers/features/docker-in-docker:2": { }
+  },
 
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   // "forwardPorts": [],
@@ -26,7 +30,9 @@
         "esbenp.prettier-vscode",
         "dbaeumer.vscode-eslint",
         "Angular.ng-template",
-        "vitest.explorer"
+        "vitest.explorer",
+        "SanjulaGanepola.github-local-actions",
+        "GitHub.vscode-github-actions"
       ],
       "settings": {
         "editor.defaultFormatter": "esbenp.prettier-vscode",

.github/workflows/gh-pages-deploy.yml

@@ -0,0 +1,54 @@
+name: Github Pages Deploy
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+        # Step 2: Set up Node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '22'
+
+      - name: Cache node modules
+        id: cache-npm
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
+        name: List the state of node modules
+        continue-on-error: true
+        run: npm list
+
+      - name: Install and Build 🔧
+        run: |
+          npm ci
+          npx nx run filesystem:build-storybook --configuration=ci
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist/storybook/filesystem
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.vscode/extensions.json

@@ -4,6 +4,8 @@
     "esbenp.prettier-vscode",
     "dbaeumer.vscode-eslint",
     "angular.ng-template",
-    "vitest.explorer"
+    "vitest.explorer",
+    "sanjulaganepola.github-local-actions",
+    "github.vscode-github-actions"
   ]
 }