New feature lint php

.github/workflows/lint-php.yml

@@ -0,0 +1,58 @@
+name: Lint PHP
+
+on:
+  workflow_call:
+    inputs:
+      PHP_MATRIX:
+        description: Matrix of PHP versions as a JSON formatted object.
+        default: '["8.0"]'
+        required: false
+        type: string
+      COMPOSER_ARGS:
+        description: Set of arguments passed to Composer.
+        default: '--prefer-dist'
+        required: false
+        type: string
+      LINT_ARGS:
+        description: Set of arguments passed to PHP Parallel Lint.
+        default: '. -e php --colors --show-deprecated'
+        required: false
+        type: string
+      COMPOSER_DEPS_INSTALL:
+        description: Whether or not to install Composer dependencies before linting.
+        type: boolean
+        default: false
+        required: false
+    secrets:
+      COMPOSER_AUTH_JSON:
+        description: Authentication for privately hosted packages and repositories as a JSON formatted object.
+        required: false
+
+jobs:
+  lint-php:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: ${{ fromJson(inputs.PHP_MATRIX) }}
+    env:
+      COMPOSER_AUTH: '${{ secrets.COMPOSER_AUTH_JSON }}'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: cs2pr, parallel-lint
+          coverage: none
+
+      - name: Install Composer dependencies
+        if: ${{ inputs.COMPOSER_DEPS_INSTALL }}
+        uses: ramsey/composer-install@v1
+        with:
+          composer-options: ${{ inputs.COMPOSER_ARGS }}
+
+      - name: Run PHP lint check
+        run: parallel-lint ${{ inputs.LINT_ARGS }} --checkstyle | cs2pr

docs/php.md

@@ -139,10 +139,60 @@ jobs:
     uses: inpsyde/reusable-workflows/.github/workflows/tests-unit-php.yml@main
     secrets:
       COMPOSER_AUTH_JSON: ${{ secrets.COMPOSER_AUTH_JSON }}
+      ENV_VARS: >-
+        [{"name":"EXAMPLE_USERNAME", "value":"deploybot"}, {"name":"EXAMPLE_TOKEN", "value":"${{ secrets.EXAMPLE_TOKEN }}"}]
     with:
       PHP_MATRIX: >-
         ["7.4", "8.0", "8.1"]
       PHPUNIT_ARGS: '--coverage-text --debug'
-      ENV_VARS: >-
-        [{"name":"EXAMPLE_USERNAME", "value":"deploybot"}, {"name":"EXAMPLE_TOKEN", "value":"${{ secrets.EXAMPLE_TOKEN }}"}]
+```
+
+## Lint PHP
+
+This workflow runs [PHP Parallel Lint](https://github.com/php-parallel-lint/PHP-Parallel-Lint). 
+
+**Simplest possible example:**
+
+```yml
+name: Lint PHP
+on:
+  pull_request:
+jobs:
+  lint-php:
+    uses: inpsyde/reusable-workflows/.github/workflows/lint-php.yml@main
+```
+
+### Configuration parameters
+
+#### Inputs
+
+| Name                    | Default                                 | Description                                                    |
+|-------------------------|-----------------------------------------|----------------------------------------------------------------|
+| `PHP_MATRIX`            | `["8.0"]`                               | Matrix of PHP versions as a JSON formatted object              |
+| `COMPOSER_ARGS`         | `'--prefer-dist'`                       | Set of arguments passed to Composer                            |
+| `LINT_ARGS`             | `'-e php --colors --show-deprecated .'` | Set of arguments passed to PHP Parallel Lint                   |
+| `COMPOSER_DEPS_INSTALL` | `false`                                 | Whether or not to install Composer dependencies before linting |
+
+#### Secrets
+
+| Name                 | Description                                                                              |
+|----------------------|------------------------------------------------------------------------------------------|
+| `COMPOSER_AUTH_JSON` | Authentication for privately hosted packages and repositories as a JSON formatted object |
+
+**Example with configuration parameters:**
+
+```yml
+name: Lint PHP
+on:
+  pull_request:
+jobs:
+  lint-php:
+    uses: inpsyde/reusable-workflows/.github/workflows/lint-php.yml@main
+    secrets:
+      COMPOSER_AUTH_JSON: ${{ secrets.COMPOSER_AUTH_JSON }}
+    with:
+      PHP_MATRIX: >-
+        ["7.4", "8.0", "8.1"]
+      LINT_ARGS: '. --exclude vendor'
+      COMPOSER_DEPS_INSTALL: true
 ```