deploy.yml

name: Deploy

on:
  workflow_call:
    inputs:
      environment:
        required: true
        type: string
      prefix:
        required: false
        default: branches
        type: string
      base_url:
        required: false
        default: "https://staging-editor-static.raspberrypi.org"
        type: string
      assets_url:
        required: false
        default: "https://staging-editor-static.raspberrypi.org"
        type: string
      react_app_api_endpoint:
        required: false
        default: "https://staging-editor-api.raspberrypi.org"
        type: string
      react_app_authentication_client_id:
        required: false
        default: editor-api
        type: string
      react_app_authentication_url:
        required: false
        default: "https://staging-auth-v1.raspberrypi.org"
        type: string
      react_app_base_url:
        required: false
        default: "unspecified"
        type: string
      react_app_cookiebot_domain_group_id:
        required: false
        default: "1e9a6bdd-5870-4d54-8e5f-adcf6b5c5499"
        type: string
      react_app_google_tag_manager_id:
        required: false
        default: ""
        type: string
      react_app_plausible_data_domain:
        required: false
        default: "staging-editor-static.raspberrypi.org"
        type: string
      react_app_plausible_source:
        required: false
        default: "https://staging-analytics.raspberrypi.org/js/plausible.js"
        type: string
      react_app_sentry_dsn:
        required: false
        default: "https://a6d7b79c7a474a6499ace73acf792a83@o17504.ingest.sentry.io/4504055099621376"
        type: string
      react_app_sentry_env:
        required: false
        default: "review"
        type: string
    secrets:
      AWS_ACCESS_KEY_ID:
        required: true
      AWS_REGION:
        required: true
      AWS_S3_BUCKET:
        required: true
      AWS_SECRET_ACCESS_KEY:
        required: true
      AWS_ENDPOINT:
        required: true

jobs:
  setup-environment:
    runs-on: ubuntu-latest
    outputs:
      deploy_dir: ${{ steps.setup-environment.outputs.deploy_dir }}
      public_url: ${{ steps.setup-environment.outputs.public_url }}
      assets_url: ${{ steps.setup-environment.outputs.assets_url }}
      react_app_base_url: ${{ steps.setup-environment.outputs.react_app_base_url }}
    steps:
      - id: setup-environment
        run: |
          safe_ref_name="${GITHUB_REF_NAME//[![:alnum:].]/_}"
          deploy_dir=${{inputs.prefix}}/$safe_ref_name
          public_url=${{inputs.base_url}}/$deploy_dir
          assets_url=${{inputs.assets_url}}/$deploy_dir
          echo "deploy_dir=$deploy_dir" >> $GITHUB_OUTPUT
          echo "public_url=$public_url" >> $GITHUB_OUTPUT
          echo "assets_url=$assets_url" >> $GITHUB_OUTPUT
          if [ "${{inputs.react_app_base_url}}" = "unspecified" ] ; then
            echo "react_app_base_url=$deploy_dir" >> $GITHUB_OUTPUT
          else
            echo "react_app_base_url=${{inputs.react_app_base_url}}" >> $GITHUB_OUTPUT
          fi

  build-deploy:
    runs-on: ubuntu-latest
    needs: setup-environment
    environment:
      name: ${{ inputs.environment }}
      url: ${{ needs.setup-environment.outputs.public_url }}
    steps:
      - name: Check deployment path
        run: |
          echo "Deploying to '${{ needs.setup-environment.outputs.deploy_dir }}' -- job will fail if this is empty!"
          [ -n "${{ needs.setup-environment.outputs.deploy_dir }}" ]

      - name: Checkout
        uses: actions/checkout@v4

      - name: Cache dependencies
        uses: actions/setup-node@v4
        with:
          node-version: 16
          cache: "yarn"
          registry-url: "https://npm.pkg.github.com"
          # Defaults to the user or organization that owns the workflow file
          scope: "@RaspberryPiFoundation"

      - name: Install code
        run: yarn install --immutable
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Build WC bundle
        run: |
          # TODO: Reinitialise when storybook build is fixed
          # if [[ "${{ inputs.environment }}" != "production" ]]; then
          #   yarn build:dev
          # fi
          yarn build
        env:
          PUBLIC_URL: ${{ needs.setup-environment.outputs.public_url }}
          ASSETS_URL: ${{ needs.setup-environment.outputs.assets_url }}
          REACT_APP_API_ENDPOINT: ${{ inputs.react_app_api_endpoint }}
          REACT_APP_AUTHENTICATION_CLIENT_ID: ${{ inputs.react_app_authentication_client_id }}
          REACT_APP_AUTHENTICATION_URL: ${{ inputs.react_app_authentication_url }}
          REACT_APP_BASE_URL: ${{ needs.setup-environment.outputs.react_app_base_url }}
          REACT_APP_COOKIEBOT_DOMAIN_GROUP_ID: ${{ inputs.react_app_cookiebot_domain_group_id }}
          REACT_APP_GOOGLE_TAG_MANAGER_ID: ${{ inputs.react_app_google_tag_manager_id }}
          REACT_APP_PLAUSIBLE_DATA_DOMAIN: ${{ inputs.react_app_plausible_data_domain }}
          REACT_APP_PLAUSIBLE_SOURCE: ${{ inputs.react_app_plausible_source }}
          REACT_APP_SENTRY_DSN: ${{ inputs.react_app_sentry_dsn }}
          REACT_APP_SENTRY_ENV: ${{ inputs.react_app_sentry_env }}

      - name: Deploy site to S3 bucket
        run: aws s3 sync  ./build/ s3://${{ secrets.AWS_S3_BUCKET }}/${{ needs.setup-environment.outputs.deploy_dir }} --endpoint ${{ secrets.AWS_ENDPOINT }}
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          AWS_REGION: ${{ secrets.AWS_REGION }}