name: Deploy Documentation
on:
push:
branches:
- main
paths:
- 'docs-site/**'
- '.github/workflows/deploy-docs.yml'
pull_request:
branches:
- main
paths:
- 'docs-site/**'
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
cache: 'npm'
cache-dependency-path: docs-site/package-lock.json
- name: Install dependencies
working-directory: docs-site
run: npm install
- name: Build documentation
working-directory: docs-site
run: npm run build
- name: check doc-site
run: pwd; ls -ltr
- name: Deploy to Vercel
uses: amondnet/vercel-action@v25.2.0
with:
vercel-token: ${{ secrets.VERCEL_TOKEN }}
vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
working-directory: ./docs-site
vercel-args: '--prod'
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
- name: Preview Deployment
uses: amondnet/vercel-action@v25.2.0
with:
vercel-token: ${{ secrets.VERCEL_TOKEN }}
vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
working-directory: ./docs-site
if: github.event_name == 'pull_request'