Deploy Hugo site to Pages #1635
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
| # Sample workflow for building and deploying a Hugo site to GitHub Pages | |
| name: Deploy Hugo site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["master"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Runs automatically at 6 a.m. UTC every day | |
| schedule: | |
| - cron: '0 6 * * *' | |
| # 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: | |
| shell: bash | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| HUGO_VERSION: 0.127.0 | |
| 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: sudo snap install dart-sass | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - 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: Build with Hugo | |
| env: | |
| # For maximum backward compatibility with Hugo modules | |
| HUGO_ENVIRONMENT: production | |
| HUGO_ENV: production | |
| run: | | |
| hugo \ | |
| --minify \ | |
| --baseURL "${{ steps.pages.outputs.base_url }}/" | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./public | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: https://jaxplays.org | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| - name: Send Pushover Success Notification | |
| if: success() # This ensures the step only runs if the previous steps were successful | |
| uses: umahmood/pushover-actions@main | |
| env: | |
| PUSHOVER_TOKEN: ${{ secrets.PUSHOVER_TOKEN }} | |
| PUSHOVER_USER: ${{ secrets.PUSHOVER_USER }} | |
| with: | |
| status: ${{ job.status }} | |
| title: 'Success! Deployment Complete' | |
| message: 'Your update to jaxplays.org has been successfully deployed to GitHub Pages.' | |
| - name: Send Pushover Failure Notification | |
| if: failure() # This ensures the step only runs if the previous steps failed | |
| uses: umahmood/pushover-actions@main | |
| env: | |
| PUSHOVER_TOKEN: ${{ secrets.PUSHOVER_TOKEN }} | |
| PUSHOVER_USER: ${{ secrets.PUSHOVER_USER }} | |
| with: | |
| status: ${{ job.status }} | |
| title: 'Failed. Deployment Incomplete' | |
| message: 'Your update to jaxplays.org has failed to deploy to GitHub Pages. Check the logs for details.' |