deploy

Deep Wiki: Deploy to GitHub Pages

Generate a .github/workflows/deploy-wiki.yml GitHub Actions workflow that builds and deploys the VitePress wiki to GitHub Pages.

Step 1: Check Prerequisites

Before generating the workflow:

1. Verify wiki exists: Check that wiki/ directory and wiki/package.json exist
   • If not, tell the user: "Run /deep-wiki:build first to scaffold the VitePress site."
2. Check for existing deployment workflows: Search for ANY existing GitHub Pages workflow:

   # Check for exact file
   ls .github/workflows/deploy-wiki.yml 2>/dev/null
   # Check for any pages-related workflow
   grep -rl "deploy-pages\|pages-artifact\|github-pages" .github/workflows/ 2>/dev/null
   

   • If deploy-wiki.yml exists → STOP. Tell the user: "A deployment workflow already exists at .github/workflows/deploy-wiki.yml. No changes needed."
   • If a DIFFERENT pages workflow exists → ASK the user: "I found an existing GitHub Pages workflow at {path}. Should I skip creating a new one, or create deploy-wiki.yml alongside it?"
   • If no pages workflow exists → proceed with generation

Step 2: Generate Workflow File

Create .github/workflows/deploy-wiki.yml:

name: Deploy Wiki to GitHub Pages

on:
  push:
    branches: [main]
    paths:
      - 'wiki/**'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: wiki/package-lock.json

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Install dependencies
        run: npm ci
        working-directory: wiki

      - name: Build with VitePress
        run: npm run build
        working-directory: wiki

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: wiki/.vitepress/dist

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4