|
| 1 | +# Workflow for building and deploying Hugo PR previews to GitHub Pages |
| 2 | +name: preview-deploy |
| 3 | + |
| 4 | +on: |
| 5 | + pull_request_target: |
| 6 | + branches: [ "master" ] |
| 7 | + types: [opened, synchronize, reopened] |
| 8 | + |
| 9 | + workflow_dispatch: |
| 10 | + |
| 11 | +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages and comments |
| 12 | +permissions: |
| 13 | + contents: write |
| 14 | + pages: write |
| 15 | + pull-requests: write |
| 16 | + |
| 17 | +concurrency: |
| 18 | + group: "pages-${{ github.event.pull_request.number || github.run_id }}" |
| 19 | + cancel-in-progress: true |
| 20 | + |
| 21 | +# Default to bash |
| 22 | +defaults: |
| 23 | + run: |
| 24 | + shell: bash |
| 25 | + |
| 26 | +jobs: |
| 27 | + # Build and Deploy job |
| 28 | + build-and-deploy: |
| 29 | + runs-on: ubuntu-latest |
| 30 | + env: |
| 31 | + HUGO_VERSION: 0.147.9 |
| 32 | + steps: |
| 33 | + - name: Install Hugo CLI |
| 34 | + run: | |
| 35 | + wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \ |
| 36 | + && sudo dpkg -i ${{ runner.temp }}/hugo.deb |
| 37 | +
|
| 38 | + - name: Install Dart Sass |
| 39 | + run: sudo snap install dart-sass |
| 40 | + |
| 41 | + - name: Checkout |
| 42 | + uses: actions/checkout@v6 |
| 43 | + with: |
| 44 | + ref: ${{ github.event.pull_request.head.sha }} |
| 45 | + submodules: recursive |
| 46 | + fetch-depth: 0 |
| 47 | + |
| 48 | + - name: Install Node.js dependencies |
| 49 | + run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" |
| 50 | + |
| 51 | + - name: Build with Hugo |
| 52 | + env: |
| 53 | + # For maximum backward compatibility with Hugo modules |
| 54 | + HUGO_ENVIRONMENT: production |
| 55 | + HUGO_ENV: production |
| 56 | + run: | |
| 57 | + # Dynamically set BaseURL for PR preview |
| 58 | + # Format: https://<ORG>.github.io/<REPO>/pr-preview/pr-<NUMBER>/ |
| 59 | + # We use github context to make it generic |
| 60 | + REPO_NAME=$(echo "${{ github.repository }}" | cut -d'/' -f2) |
| 61 | + ORG_NAME=$(echo "${{ github.repository }}" | cut -d'/' -f1) |
| 62 | + |
| 63 | + PR_BASE_URL="https://${ORG_NAME}.github.io/${REPO_NAME}/pr-preview/pr-${{ github.event.pull_request.number }}/" |
| 64 | + |
| 65 | + echo "Building for BaseURL: ${PR_BASE_URL}" |
| 66 | + |
| 67 | + hugo \ |
| 68 | + --gc \ |
| 69 | + --minify \ |
| 70 | + --buildDrafts \ |
| 71 | + --buildFuture \ |
| 72 | + --baseURL "${PR_BASE_URL}" |
| 73 | + |
| 74 | + - name: Deploy PR Preview |
| 75 | + id: deploy-preview |
| 76 | + uses: rossjrw/pr-preview-action@v1.6.3 |
| 77 | + with: |
| 78 | + source-dir: ./public |
| 79 | + preview-branch: gh-pages |
| 80 | + umbrella-dir: pr-preview |
| 81 | + action: auto |
| 82 | + comment: false |
| 83 | + |
| 84 | + - name: Comment PR with Preview URL |
| 85 | + uses: marocchino/sticky-pull-request-comment@v2 |
| 86 | + if: github.event_name == 'pull_request_target' |
| 87 | + with: |
| 88 | + header: pr-preview |
| 89 | + message: | |
| 90 | + 🚀 **Preview deployment for PR #${{ github.event.pull_request.number }}** |
| 91 | + |
| 92 | + 🌐 **Preview URL**: ${{ steps.deploy-preview.outputs.preview-url }} |
| 93 | + |
| 94 | + _This preview will be updated automatically when you push new commits to this PR._ |
0 commit comments