build.yml

name: Build

on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch: # allows to be run manually
  workflow_call: # when called from another workflow
    inputs:
      checkout_ref:
        required: true
        type: string
    outputs:
      production_artifact_name:
        value: ${{ jobs.build.outputs.production_artifact_name }}

env:
  PREPARED_NODE_MODULES_ARTIFACT_NAME: node_modules
  PRODUCTION_ARTIFACT_NAME: dist
  DEVELOPMENT_ARTIFACT_NAME: dist-development

permissions:
  contents: read

jobs:
  prepare_cache:
    name: Prepare cache
    # to populate the cache for the following jobs that have this one in 'needs'
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          ref: ${{ inputs.checkout_ref }}
      - name: Prepare the project
        uses: ./.github/actions/prepare
        with:
          save-cache: true
  build_dev:
    name: Build development version
    needs: prepare_cache
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          ref: ${{ inputs.checkout_ref }}
      - name: Prepare the project
        uses: ./.github/actions/prepare
      - name: Build add-on (development version)
        run: make build_in_container
        env:
          MODE: development
      - name: Save built add-on (development version)
        uses: actions/upload-artifact@v4
        with:
          name: ${{ env.DEVELOPMENT_ARTIFACT_NAME }}
          path: dist
          retention-days: 30
  build:
    name: Build production version
    needs: prepare_cache
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          ref: ${{ inputs.checkout_ref }}
      - name: Prepare the project
        uses: ./.github/actions/prepare
      - name: Build add-on
        run: make build_in_container
      - name: Save built add-on
        uses: actions/upload-artifact@v4
        with:
          name: ${{ env.PRODUCTION_ARTIFACT_NAME }}
          path: dist
          retention-days: 30
    outputs:
      production_artifact_name: ${{ env.PRODUCTION_ARTIFACT_NAME }}
  test:
    name: Run tests
    needs: prepare_cache
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          ref: ${{ inputs.checkout_ref }}
      - name: Prepare the project
        uses: ./.github/actions/prepare
      - name: Run tests
        run: make test_in_container
      - name: Upload code coverage report
        uses: actions/upload-artifact@v4
        with:
          name: coverage
          path: coverage
          retention-days: 30
      - name: Show code coverage in summary
        run: |
          summary="$(npx -y tsx@4 scripts/test-coverage-github-summary.ts)"
          echo "${summary}" >> $GITHUB_STEP_SUMMARY
  generated_code_consistency:
    name: Verify generated code is consistent
    needs: prepare_cache
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          ref: ${{ inputs.checkout_ref }}
      - name: Prepare the project
        uses: ./.github/actions/prepare
      - name: Generate GraphQL code
        run: make graphql_generate
      - name: Check changes in generated code
        run: |
          git status
          git diff
          UNCOMMITTED_CHANGES="$(git status --porcelain)"
          if [ -n "${UNCOMMITTED_CHANGES}" ]; then
            echo 'Found uncommitted changes' >&2
            exit 1
          fi