deploy-pr-preview.yaml

name: Deploy to PR Preview

on:
  pull_request:
    branches:
      - main

env:
  PR_PREVIEW_PULL_REQUEST_NUMBER: ${{github.event.pull_request.number}}
  PR_PREVIEW_BRANCH_NAME: ${{ github.head_ref || github.ref_name }} 
  PR_PREVIEW_SUBDOMAIN: pr-${{github.event.pull_request.number}}-preview
  PR_PREVIEW_DEPLOY_LOG_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
  PR_PREVIEW_BUCKET: s3://khpreview.dea.ga.gov.au
  PR_PREVIEW_KH_DOCUMENTATION: https://docs.dev.dea.ga.gov.au/public_services/dea_knowledge_hub/index.html

permissions:
  id-token: write # For requesting the JWT used by OIDC Authentication
  issues: write
  pull-requests: write

jobs:
  pr-preview:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        python-version: ["3.11"]
        node-version: [18.x]

    steps:
      - name: Find Comment
        uses: peter-evans/find-comment@v3
        id: find-comment
        with:
          issue-number: ${{ github.event.pull_request.number }}
          body-includes: "#pr-preview-comment"

      - name: "Comment: PR Preview is deploying"
        uses: peter-evans/create-or-update-comment@v4
        id: pr-preview-deploying
        with:
          issue-number: ${{github.event.pull_request.number}}
          comment-id: ${{ steps.find-comment.outputs.comment-id }}
          edit-mode: replace
          body: |
            ## Preview is deploying ...

            <table> <!-- #pr-preview-comment -->
                <tr>
                    <td><strong>View the preview:</strong></td>
                    <td><a href="https://${{ env.PR_PREVIEW_SUBDOMAIN }}.khpreview.dea.ga.gov.au/">:hourglass: Not deployed yet</a></td>
                </tr>
            </table>

            You can also <a href="${{ env.PR_PREVIEW_DEPLOY_LOG_URL }}">view the deploy log</a> or <a href="${{ env.PR_PREVIEW_KH_DOCUMENTATION }}">read the documentation</a>.

      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: true

      - name: Pull latest from submodules
        run: git submodule foreach git pull origin stable
          # This doesn't update the submodule to the latest commit on the origin; therefore, you should manually do this on a semi-regular basis.

      - name: Install Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'  # Use pip to cache the installed dependencies

      - name: Install dependencies
        run: ./install-dependencies.sh

      - name: Build site
        env:
          BUILD_MODE: pr-preview
        run: ./build-pr-preview.sh

      - name: Configure AWS credentials via OIDC
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: arn:aws:iam::538673716275:role/github-actions-dea-knowledge-hub-prs
          aws-region: ap-southeast-2

      - name: Deploy preview site
        run: |
          aws s3 sync --delete output "$PR_PREVIEW_BUCKET/$PR_PREVIEW_SUBDOMAIN"

      - name: "Comment: PR Preview is ready"
        uses: peter-evans/create-or-update-comment@v4
        with:
          issue-number: ${{github.event.pull_request.number}}
          comment-id: ${{ steps.pr-preview-deploying.outputs.comment-id }}
          edit-mode: replace
          body: |
            ## Preview is ready!

            <table> <!-- #pr-preview-comment -->
                <tr>
                    <td><strong>View the preview:</strong></td>
                    <td><a href="https://${{ env.PR_PREVIEW_SUBDOMAIN }}.khpreview.dea.ga.gov.au/">:globe_with_meridians: PR Preview ${{github.event.pull_request.number}}</a></td>
                </tr>
            </table>

            You can also <a href="${{ env.PR_PREVIEW_DEPLOY_LOG_URL }}">view the deploy log</a> or <a href="${{ env.PR_PREVIEW_KH_DOCUMENTATION }}">read the documentation</a>.