lint.yaml

name: Lint

on:
    push:
        branches: [ main ]
    pull_request: ~
    schedule:
        # Do not make it the first of the month and/or midnight since it is a very busy time
        - cron: "* 10 5 * *"

# See https://stackoverflow.com/a/72408109
concurrency:
    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
    cancel-in-progress: true

jobs:
    cs:
        runs-on: ubuntu-latest
        name: CS
        steps:
            -   name: Checkout
                uses: actions/checkout@v4

            -   name: Setup PHP
                uses: shivammathur/setup-php@v2
                with:
                    php-version: '8.2'
                    tools: composer
                    coverage: none

            -   name: Install Composer dependencies
                uses: ./.github/actions/install-vendor

            -   name: Install PHP-CS-Fixer
                uses: ./.github/actions/install-tool
                with:
                    vendor-bin-tool: php-cs-fixer
                    makefile-command: php_cs_fixer_install

            -   run: make cs_lint
    phpstan:
        runs-on: ubuntu-latest
        name: PHPStan
        steps:
            -   name: Checkout
                uses: actions/checkout@v4

            -   name: Setup PHP
                uses: shivammathur/setup-php@v2
                with:
                    php-version: '8.3'
                    tools: composer
                    coverage: none

            -   name: Install Composer dependencies
                uses: ./.github/actions/install-vendor

            -   name: Install PHPStan
                uses: ./.github/actions/install-tool
                with:
                    vendor-bin-tool: phpstan
                    makefile-command: phpstan_install

            -   run: make phpstan
    rector:
        runs-on: ubuntu-latest
        name: Rector
        steps:
            -   name: Checkout
                uses: actions/checkout@v4

            -   name: Setup PHP
                uses: shivammathur/setup-php@v2
                with:
                    php-version: '8.2'
                    tools: composer
                    coverage: none

            -   name: Install Composer dependencies
                uses: ./.github/actions/install-vendor

            -   name: Install Rector
                uses: ./.github/actions/install-tool
                with:
                    vendor-bin-tool: rector
                    makefile-command: rector_install

            -   run: make rector_lint

    # This is a "trick", a meta task which does not change, and we can use in
    # the protected branch rules as opposed to the E2E tests one above which
    # may change regularly.
    # This allows us to mark only this job as required instead of each individual
    # ever-changing E2E tests.
    validate-tests:
        name: Lint Status
        runs-on: ubuntu-latest
        needs:
            - cs
            - phpstan
            - rector
        if: always()
        steps:
            - name: Successful run
              if: ${{ !(contains(needs.*.result, 'failure')) }}
              run: exit 0

            - name: Failing run
              if: ${{ contains(needs.*.result, 'failure') }}
              run: exit 1