docs: restore preview environment for non-main branches #488
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: Deploy to GitHub Pages | |
on: | |
push: | |
branches: | |
- main | |
- docs-test | |
paths: | |
- 'docs/**' | |
- '.github/workflows/publish-docs.yaml' | |
pull_request: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- '.github/workflows/publish-docs.yaml' | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
# Build job | |
build: | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: docs | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-node@v3 | |
with: | |
node-version: 18 | |
cache: npm | |
cache-dependency-path: docs/package-lock.json | |
- name: Install dependencies | |
run: npm ci | |
- name: Test build | |
run: | | |
npm run build | |
# Basic tests to ensure critical files exist | |
test -f build/index.html || exit 1 | |
test -d build/docs || exit 1 | |
test -d build/assets || exit 1 | |
- name: Upload pages artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: github-pages | |
path: docs/build | |
# Deploy job | |
deploy: | |
needs: build | |
runs-on: ubuntu-latest | |
environment: | |
name: ${{ github.ref == 'refs/heads/main' && 'github-pages' || 'preview' }} | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Download build | |
uses: actions/download-artifact@v4 | |
with: | |
name: github-pages | |
path: build | |
- name: Setup Pages | |
uses: actions/configure-pages@v3 | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v3 |