ci.yml

name: CI

on:
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch: {}
  push:
    branches: 
      - main
      - develop
      - feature/*
  pull_request:
    branches: 
      - main
      - develop
      - feature/*
      
permissions:
  contents: write

jobs:
  tests:
    name: Tests 🧪
    runs-on: ubuntu-latest

    steps:
    - name: Checkout 🛎️
      uses: actions/checkout@v4

    - name: Set up PHP 🐘
      uses: shivammathur/setup-php@v2
      with:
        php-version: '8.2'
        coverage: xdebug
        extensions: zip

    - name: Install dependencies 📦
      run: composer install --prefer-dist --no-progress --no-suggest

    - name: Run PHPUnit tests 🧪
      uses: php-actions/phpunit@v3
      env:
        XDEBUG_MODE: coverage
      with:
        bootstrap: vendor/autoload.php
        configuration: phpunit.xml
        php_extensions: xdebug zip
        args: tests --coverage-clover ./coverage.xml
        
    - name: Upload to Codecov 📊
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        files: ./coverage.xml
        verbose: true
  
  documentation:
    name: Documentation 📚
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest

    steps:
    - name: Checkout 🛎️ 
      uses: actions/checkout@v3

    - name: Generate documentation 📚
      # create documentation folder if not exists then run phpdoc
      run: docker run --rm -v ${{ github.workspace }}:/data phpdoc/phpdoc:latest run -d src -t docs

    - name: Deploy documentation 🚀
      uses: JamesIves/github-pages-deploy-action@4.1.4
      with:
        branch: documentation
        folder: docs