📚 Build and Deploy Docs #21
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: 📚 Build and Deploy Docs | |
| on: | |
| pull_request: | |
| branches: | |
| - "main" | |
| push: | |
| tags: | |
| - "hyper-docs@*" | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: ⬇️ Checkout repo | |
| uses: actions/checkout@v3 | |
| - name: ⎔ Setup Node | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| cache: yarn | |
| - name: 📜 Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Install dependencies | |
| run: yarn | |
| - name: 🛠 Build Docs | |
| run: | | |
| yarn build | |
| touch src/.vitepress/dist/.nojekyll | |
| - name: 🔼 Upload Artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: src/.vitepress/dist | |
| deploy: | |
| if: github.ref == 'refs/heads/main' | |
| needs: build | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| name: Deploy | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |