feat: add workflow to preview prs #18
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: Preview Hugo Site | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| # Set permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| # Allow only one concurrent deployment | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
| # Default to bash | ||
| defaults: | ||
| run: | ||
| shell: bash | ||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-20.04 | ||
| env: | ||
| PR_PATH: pull/${{github.event.number}} | ||
| steps: | ||
| - name: Comment on PR | ||
| uses: hasura/comment-progress@v2.2.0 | ||
| if: github.ref != 'refs/heads/main' | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| repository: ${{ github.repository }} | ||
| number: ${{ github.event.number }} | ||
| id: deploy-preview | ||
| message: "Starting deployment of preview ⏳..." | ||
| steps: | ||
| - name: Install Hugo CLI | ||
| env: | ||
| HUGO_VERSION: 0.120.4 | ||
| 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: Check out repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| fetch-depth: 0 | ||
| - 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: Set production base URL | ||
| run: echo "BASE_URL=https://${{ env.DOMAIN }}/${{ github.event.repository.name }}/" >> $GITHUB_ENV | ||
| - name: Build website with Hugo | ||
| env: | ||
| # For maximum backward compatibility with Hugo modules | ||
| HUGO_ENVIRONMENT: production | ||
| HUGO_ENV: production | ||
| run: | | ||
| hugo \ | ||
| --gc \ | ||
| --minify | ||
| --baseURL "${{ env.BASE_URL }}" | ||
| # - name: Upload artifact for GitHub Pages | ||
| # uses: actions/upload-pages-artifact@v3 | ||
| # with: | ||
| # path: ./public | ||
| - name: Deploy if this is the `main` branch | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| if: github.ref == 'refs/heads/main' | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./public | ||
| cname: ${{ env.DOMAIN }} # TODO you need to set this if you're using a custom domain. Otherwise you can remove it. | ||
| - name: Set base URL for preview if PR | ||
| if: github.ref != 'refs/heads/main' | ||
| run: echo "BASE_URL=https://${{ env.DOMAIN }}/${{ github.event.repository.name }}/${{ env.PR_PATH}}/" >> $GITHUB_ENV | ||
| - name: Build PR preview website | ||
| if: github.ref != 'refs/heads/main' | ||
| run: hugo --baseURL "${{ env.BASE_URL }}" | ||
| env: | ||
| HUGO_ENV: staging | ||
| - name: Deploy to PR preview | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| if: github.ref != 'refs/heads/main' | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./public | ||
| destination_dir: ${{ env.PR_PATH }} # TODO you need to set this if you're using a custom domain. Otherwise you can remove it. | ||
| - name: Update comment | ||
| uses: hasura/comment-progress@v2.2.0 | ||
| if: github.ref != 'refs/heads/main' | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| repository: ${{ github.repository }} | ||
| number: ${{ github.event.number }} | ||
| id: deploy-preview | ||
| message: "A preview of ${{ github.event.after }} is uploaded and can be seen here:\n\n ✨ ${{ env.BASE_URL }} ✨\n\nChanges may take a few minutes to propagate. Since this is a preview of production, content with `draft: true` will not be rendered. The source is here: https://github.com/${{ github.repository }}/tree/gh-pages/${{ env.PR_PATH }}/" | ||
| # # 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 | ||
| # - name: Deploy to GitHub Pages | ||
| # uses: peaceiris/actions-gh-pages@v4 | ||
| # with: | ||
| # github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| # publish_dir: ./public | ||
| # # Deploy to a subdirectory for each PR | ||
| # destination_dir: "preview/${{ github.event.number }}-${{ github.sha }}" | ||
