test-deptrac.yml

# When a PR is opened or a push is made, perform an
# architectural inspection on the code using Deptrac.
name: Deptrac

on:
  pull_request:
    branches:
      - 'develop'
      - '4.*'
    paths:
      - 'app/**.php'
      - 'system/**.php'
      - 'composer.json'
      - 'depfile.yaml'
      - '.github/workflows/test-deptrac.yml'
  push:
    branches:
      - 'develop'
      - '4.*'
    paths:
      - 'app/**.php'
      - 'system/**.php'
      - 'composer.json'
      - 'depfile.yaml'
      - '.github/workflows/test-deptrac.yml'

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  build:
    name: Architectural Inspection
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.1'
          tools: composer, phive
          extensions: intl, json, mbstring, gd, mysqlnd, xdebug, xml, sqlite3

      - name: Validate composer.json
        run: composer validate --strict

      - name: Get composer cache directory
        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV

      - name: Cache dependencies
        uses: actions/cache@v3
        with:
          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
          restore-keys: ${{ runner.os }}-composer-

      - name: Create Deptrac cache directory
        run: mkdir -p build/

      - name: Cache Deptrac results
        uses: actions/cache@v3
        with:
          path: build
          key: ${{ runner.os }}-deptrac-${{ github.sha }}
          restore-keys: ${{ runner.os }}-deptrac-

      - name: Install dependencies
        run: composer update --ansi --no-interaction

      - name: Run architectural inspection
        run: |
            sudo phive --no-progress install --global qossmic/deptrac --trust-gpg-keys B8F640134AB1782E
            deptrac analyze --cache-file=build/deptrac.cache
        env:
          GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}