build.yml

# SPDX-FileCopyrightText: 2025 Alexandre Gomes Gaigalas <alganet@gmail.com>
# SPDX-License-Identifier: BSD-3-Clause

name: CI
permissions: {}

env:
  ALL_FILES_MIN_COVERAGE: 20
  CHANGED_FILES_MIN_COVERAGE: 25

on:
  push:
    branches: [ main ]
    paths:
      - 'src/**'
      - 'tests/**'
      - 'Makefile'
      - 'build-aux/**'
      - '.github/workflows/build.yml'
  pull_request:
    branches: [ main, dev ]
    paths:
      - 'src/**'
      - 'tests/**'
      - 'Makefile'
      - 'build-aux/**'
      - '.github/workflows/build.yml'

jobs:
  build:
    runs-on: ${{ matrix.os }}
    permissions:
      contents: read
    strategy:
      matrix:
        include:
          - mode: full
            name: x86_64-linux-gnu
            os: ubuntu-latest
          - mode: full
            name: x86_64-windows-msvc
            os: windows-latest
            extension: .exe
          - mode: full
            name: arm64-apple-darwin
            os: macos-latest
          - mode: full
            name: x86_64-apple-darwin
            os: macos-15-intel
          - mode: tiny
            name: x86_64-linux-gnu
            os: ubuntu-latest
          - mode: tiny
            name: x86_64-windows-msvc
            os: windows-latest
            extension: .exe
          - mode: tiny
            name: arm64-apple-darwin
            os: macos-latest
          - mode: tiny
            name: x86_64-apple-darwin
            os: macos-15-intel
    steps:
    - uses: actions/checkout@v6
    - uses: ./.github/actions/setup-action
    - uses: ./.github/actions/make-action
      with:
        name: ${{ matrix.name }}
        mode: ${{ matrix.mode }}
        extension: ${{ matrix.extension }}
        artifacts: 'true'

  qa:
    runs-on: ${{ matrix.os }}
    needs: build
    permissions:
      contents: read
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        make: [test, test-compat, coverage]
        include:
          - os: ubuntu-latest
            name: x86_64-linux-gnu
          - os: macos-latest
            name: arm64-apple-darwin
          - os: windows-latest
            name: x86_64-windows-msvc
            extension: .exe
    steps:
    - uses: actions/checkout@v6
    - uses: ./.github/actions/setup-action
    - uses: ./.github/actions/make-action
      with:
        name: ${{ matrix.name }}
        mode: ${{ matrix.make == 'coverage' && 'coverage' || 'full' }}
        make: ${{ matrix.make == 'coverage' && 'coverage-report' || matrix.make }}
        extension: ${{ matrix.extension }}
        artifacts: ${{ matrix.make == 'coverage' && 'true' || 'false' }}
        artifacts_from: build
        artifacts_from_mode: full

  report:
    runs-on: ubuntu-latest
    needs: qa
    permissions:
      contents: write
      pull-requests: write
    steps:
    - uses: actions/checkout@v6
      with:
        fetch-depth: 0
        persist-credentials: true
    - uses: ./.github/actions/setup-action
    - uses: actions/download-artifact@v8
      with:
        pattern: coverage-report-*
        path: artifact
    - name: Coverage report
      run: |
        mkdir -p report
        chmod +x artifact/coverage-report-x86_64-linux-gnu/coverage/phl

        lcov --add-tracefile artifact/coverage-report-x86_64-linux-gnu/coverage/coverage.info \
             --add-tracefile artifact/coverage-report-x86_64-windows-msvc/coverage/coverage.info \
             --add-tracefile artifact/coverage-report-arm64-apple-darwin/coverage/coverage.info \
             --ignore-errors format \
             --output-file report/coverage.info

        genhtml --quiet --include 'src/*'\
          --output-directory report/html report/coverage.info

        ./artifact/coverage-report-x86_64-linux-gnu/coverage/phl \
          build-aux/lcov_info_to_text.php --content=all\
            report/coverage.info > report/coverage.md

        ./artifact/coverage-report-x86_64-linux-gnu/coverage/phl \
          build-aux/lcov_to_markdown.php --output-dir=report \
            report/coverage.info

        echo "### Coverage" >> report/summary.md
        echo "" >> report/summary.md

        ./artifact/coverage-report-x86_64-linux-gnu/coverage/phl \
          build-aux/lcov_info_to_text.php --content=summary\
            report/coverage.info >> report/summary.md

        echo "" >> report/summary.md
        echo "Details: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" >> report/summary.md
    - name: Coverage comment
      if: github.event_name == 'pull_request'
      run: |
        echo "<details><summary>Code Coverage Report</summary>" >> "$GITHUB_STEP_SUMMARY"
        echo "" >> "$GITHUB_STEP_SUMMARY"
        cat report/coverage.md >> "$GITHUB_STEP_SUMMARY"
        echo "</details>" >> "$GITHUB_STEP_SUMMARY"
        gh pr comment $PR_NUMBER --edit-last --create-if-none --body-file report/summary.md
      env:
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        PR_NUMBER: ${{ github.event.number }}

    - uses: actions/upload-artifact@v7
      with:
        name: report-html
        path: report/html

    - name: Coverage history
      run: |
        set -euo pipefail
        git config user.name "github-actions[bot]"
        git config user.email "github-actions[bot]@users.noreply.github.com"
        # Assumes the 'coverage' branch already exists and that actions/checkout
        # checked out with 'persist-credentials: true' (default) so we can push.
        git fetch origin coverage
        # Clean artifacts from local repo to avoid conflicts with git checkout
        rm -f artifact/coverage-report-*/coverage/coverage.info
        git checkout coverage
        git pull --ff-only origin coverage || true
        # Copy all contents of report/ to .
        cp -rf report/* . || true
        # Don't need the html/ directory in the repo
        rm -rf html report || true
        # git add markdown and info files in current dir and subdirs
        find . -type f \( -name '*.info' -o -name '*.md' \) -print0 | xargs -0 -r git add || true

    - name: Coverage push
      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
      run: |
        set -euo pipefail
        if git diff --cached --quiet; then
          echo "No changes to commit"
        else
          git commit -m "Coverage: ${GITHUB_SHA} (${GITHUB_RUN_ID})"
          git push origin coverage
        fi

    - name: Restore workspace
      if: always()
      run: |
        set -euo pipefail
        echo "Restoring workspace to original commit: ${GITHUB_SHA}"
        git fetch origin || true
        git checkout --detach "${GITHUB_SHA}" || true
        git reset --hard "${GITHUB_SHA}" || true