docs.yml 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. name: Deploy Docs
  2. on:
  3. push:
  4. branches: [ main ]
  5. paths: [ 'docs/**' ]
  6. workflow_dispatch:
  7. permissions:
  8. contents: read
  9. pages: write
  10. id-token: write
  11. concurrency:
  12. group: pages
  13. cancel-in-progress: false
  14. jobs:
  15. build:
  16. runs-on: ubuntu-latest
  17. steps:
  18. - name: Checkout
  19. uses: actions/checkout@v4
  20. with:
  21. fetch-depth: 0
  22. - name: Setup Node
  23. uses: actions/setup-node@v4
  24. with:
  25. node-version: 20
  26. cache: npm
  27. cache-dependency-path: docs/package-lock.json
  28. - name: Setup Pages
  29. uses: actions/configure-pages@v5
  30. - name: Install dependencies
  31. run: cd docs && npm ci
  32. - name: Build with VitePress
  33. run: cd docs && npx vitepress build
  34. - name: Upload artifact
  35. uses: actions/upload-pages-artifact@v3
  36. with:
  37. path: docs/.vitepress/dist
  38. deploy:
  39. environment:
  40. name: github-pages
  41. url: ${{ steps.deployment.outputs.page_url }}
  42. needs: build
  43. runs-on: ubuntu-latest
  44. name: Deploy
  45. steps:
  46. - name: Deploy to GitHub Pages
  47. id: deployment
  48. uses: actions/deploy-pages@v4