GitHub Actions

Use case 1

Quick start, if your PHP runtime set up is not important for you.

jobs:
  php-lint:
    name: "PHPLint v9"

    runs-on: ubuntu-latest

    steps:
      - name: Lint PHP files

        uses: overtrue/phplint@main
        with:
          path: .
          options: --exclude=vendor

Use case 2

Otherwise, if you want to detect specific PHP features used by scripts depending on your PHP runtime, then use this case.

jobs:
  php-lint:
    name: "PHPLint v9"

    runs-on: "${{ matrix.operating-system }}"

    strategy:
      fail-fast: false

      matrix:
        operating-system:
          - "ubuntu-22.04"

        php-version:
          - "8.2"
          - "8.3"

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          repository: sebastianbergmann/phpunit

      - name: Setup PHP runtime
        uses: shivammathur/setup-php@v2
        with:
          php-version: "${{ matrix.php-version }}"
          coverage: "none"

      - name: Lint PHP files
        run: |
          curl -Ls https://github.com/overtrue/phplint/releases/latest/download/phplint.phar -o /usr/local/bin/phplint
          chmod +x /usr/local/bin/phplint
          /usr/local/bin/phplint --no-cache --no-progress -v

Follows steps:

• retrieve source code to check with actions/checkout
• set up the PHP runtime you want to use with shivammathur/setup-php
• download the latest (or specific) version of the PHAR distribution
• and finally run PHPLint as usual, with a YAML config file or console command options