build: push files to dist branch

Author: Ben Roe

.github/workflows/deploy.yml

@@ -1,76 +1,36 @@
-name: 🚀 Deploy vitepress to help.keycapsss.com
+name: 🚀 Build and deploy vitepress
+
 on:
-  workflow_dispatch:
   push:
     branches:
-      - master # Triggers the action on push to the 'main' branch
-    # tags:
-    #   - v*.*.* # Triggers the action on tag
+      - main
+  workflow_dispatch: # Allows manual trigger
 
 jobs:
-  build:
-    name: 🚧 Build
+  build-and-deploy:
     runs-on: ubuntu-latest
     steps:
-      - name: Get latest code
-        uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v5
         with:
-          fetch-depth: 0
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
+      - name: Setup Node
+        uses: actions/setup-node@v6
         with:
-          node-version: "24"
-
-      - name: Get tag version
-        id: get_tag
-        run: echo "TAG_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
-
-      - name: Set environment variables from GitHub Secrets
-        run: |
-          echo "FTP_HOST=${{ secrets.FTP_HOST }}" >> $GITHUB_ENV
+          node-version: 24
+          cache: npm
 
       - name: Install dependencies
-        run: npm install
-
-      - name: Build Vitepress site
-        run: npm run docs:build # Assumes there's a build script in package.json
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: vitepress-dist
-          path: docs/.vitepress/dist/
-          retention-days: 1
-
-  deploy:
-    name: 🚀 Deploy
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - name: Download artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: vitepress-dist
-          path: dist/
+        run: npm ci
 
-      # - name: Clean target directory
-      #   uses: appleboy/ssh-action@master
-      #   with:
-      #     host: ${{ secrets.SSH_HOST }}
-      #     username: ${{ secrets.SSH_USERNAME }}
-      #     key: ${{ secrets.SSH_PRIVATE_KEY }}
-      #     port: ${{ secrets.SSH_PORT }}
-      #     script: |
-      #       rm -rf /data/coolify/services/pwogokkc8gggwc408s4kkos4/web/help.keycapsss.com/*
+      - name: Build with VitePress
+        run: npm run docs:build
 
-      - name: Upload files via SCP
-        uses: appleboy/scp-action@master
+      - name: Deploy to dist branch
+        uses: peaceiris/actions-gh-pages@v4
         with:
-          host: ${{ secrets.SSH_HOST }}
-          username: ${{ secrets.SSH_USERNAME }}
-          key: ${{ secrets.SSH_PRIVATE_KEY }}
-          port: ${{ secrets.SSH_PORT }}
-          source: "dist/*"
-          target: "/data/coolify/services/pwogokkc8gggwc408s4kkos4/web/help.keycapsss.com"
-          strip_components: 1
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/.vitepress/dist
+          publish_branch: dist
+          force_orphan: true # Keeps the dist branch clean without history