This file contains hidden or 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: Deploy VitePress site to Pages | |
| on: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| branches: [master] | |
| 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 | |
| # Setup Node.js | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: npm # or pnpm / yarn | |
| # Setup Pages action | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| # Install dependencies | |
| - name: Install dependencies | |
| run: npm ci # or pnpm install / yarn install / bun install | |
| # Create .env file from environment variables | |
| - name: Create .env file | |
| run: | | |
| echo "VITEPRESS_BASE=${{ secrets.VITEPRESS_BASE }}" >> .env | |
| echo "VITEPRESS_BASE_URL=${{ secrets.VITEPRESS_BASE_URL }}" >> .env | |
| # Check if .env file was created (for debugging) | |
| - name: Verify .env file contents | |
| run: cat .env | |
| # Build with VitePress | |
| - name: Build with VitePress | |
| run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build | |
| # Upload artifact | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/.vitepress/dist | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| name: Deploy | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |