Deploy Hugo site to Pages #352
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 Hugo site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: | |
| - main | |
| - master | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| inputs: | |
| hugo_update_mod: | |
| description: 'Hugo module to refresh (optional)' | |
| required: false | |
| type: string | |
| # 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 | |
| # Default to bash | |
| defaults: | |
| run: | |
| # GitHub-hosted runners automatically enable `set -eo pipefail` for Bash shells. | |
| shell: bash | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| DART_SASS_VERSION: 1.89.2 | |
| HUGO_VERSION: 0.148.0 | |
| HUGO_ENVIRONMENT: production | |
| TZ: Australia/Sydney | |
| steps: | |
| - name: Install Hugo CLI | |
| run: | | |
| wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb | |
| sudo dpkg -i ${{ runner.temp }}/hugo.deb | |
| - name: Install Dart Sass | |
| run: | | |
| wget -O ${{ runner.temp }}/dart-sass.tar.gz https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz | |
| tar -xf ${{ runner.temp }}/dart-sass.tar.gz --directory ${{ runner.temp }} | |
| mv ${{ runner.temp }}/dart-sass/ /usr/local/bin | |
| echo "/usr/local/bin/dart-sass" >> $GITHUB_PATH | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 | |
| - name: ISSUE run patches | |
| run: | | |
| shopt -s nullglob | |
| for p in patches/*.patch; do | |
| patch < "$p" || true | |
| done | |
| shopt -u nullglob | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: Install Node.js dependencies | |
| run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" | |
| - name: Cache Restore | |
| id: cache-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: | | |
| ${{ runner.temp }}/hugo_cache | |
| key: hugo-${{ github.run_id }} | |
| restore-keys: | |
| hugo- | |
| - name: Configure Git | |
| run: git config core.quotepath false | |
| - name: Update Hugo cache to get modified content | |
| env: | |
| HUGO_CACHEDIR: "${{ runner.temp }}/hugo_cache" | |
| if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.hugo_update_mod != '' }} | |
| run: | | |
| if [ "${{ inputs.hugo_update_mod }}" == "all" ]; then | |
| hugo mod clean --all | |
| else | |
| hugo mod get -u ${{ inputs.hugo_update_mod }} | |
| fi | |
| - name: Build with Hugo | |
| env: | |
| HUGO_CACHEDIR: "${{ runner.temp }}/hugo_cache" | |
| run: | | |
| hugo \ | |
| --gc \ | |
| --minify \ | |
| --baseURL "${{ steps.pages.outputs.base_url }}/" | |
| - name: Cache Save | |
| id: cache-save | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: | | |
| ${{ runner.temp }}/hugo_cache | |
| key: ${{ steps.cache-restore.outputs.cache-primary-key }} | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./public | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |