add CI scripts for PHP validation, linting, and static analysis closes 25

Author: gregor-j

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/main.yml

@@ -1,64 +1,99 @@
 name: "CI"
-# Controls when the action will run.
+
 on:
-  # Triggers the workflow on push or pull request events but only for the main branch
   push:
+    branches:
+      - "main"
   pull_request:
-
-  # Allows you to run this workflow manually from the Actions tab
+    branches:
+      - "main"
   workflow_dispatch:
 
 permissions:
   contents: "read"
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+concurrency:
+  group: "ci-${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
 jobs:
-  # composer validation
   composer:
     name: "composer config validation"
     runs-on: "ubuntu-latest"
+    timeout-minutes: 10
     steps:
-      - uses: "actions/checkout@v3"
+      - name: "git checkout"
+        uses: "actions/checkout@v4"
       - name: "Validate composer.json"
         run: "composer validate --strict"
-  # PHP lint and PHPStan for different PHP versions
+
   php:
+    name: "PHP ${{ matrix.php-version }}"
+    needs: "composer"
     runs-on: "ubuntu-latest"
+    timeout-minutes: 15
     strategy:
+      fail-fast: false
       matrix:
         php-version:
           - "8.1"
           - "8.2"
           - "8.3"
-    name: "PHP ${{ matrix.php-version }}"
     steps:
       - name: "git checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
       - name: "setup PHP"
         uses: "shivammathur/setup-php@v2"
         with:
           php-version: "${{ matrix.php-version }}"
+          extensions: "json"
           coverage: "xdebug"
+          tools: "composer:v2"
+          cache: "composer"
       - name: "check PHP version"
         run: "php -v"
       - name: "lint PHP files"
-        run: "php -l src/"
+        run: "find src -type f -name '*.php' -print0 | xargs -0 -n1 php -l"
+      - name: "install composer dependencies"
+        run: "composer install --prefer-dist --no-interaction --no-progress"
+
+  phpstan:
+    name: "PHPStan"
+    needs: "composer"
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 15
+    steps:
+      - name: "git checkout"
+        uses: "actions/checkout@v4"
+      - name: "setup PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "8.3"
+          extensions: "json"
+          tools: "composer:v2"
+          cache: "composer"
       - name: "install composer dependencies"
-        run: "composer install --prefer-dist --no-progress"
-      # PHPStan
+        run: "composer install --prefer-dist --no-interaction --no-progress"
       - name: "PHPStan static analysis"
         run: "vendor/bin/phpstan analyse --configuration=phpstan.neon"
+
   codesniffer:
+    name: "PHP CodeSniffer"
+    needs: "composer"
     runs-on: "ubuntu-latest"
+    timeout-minutes: 15
     steps:
       - name: "git checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
       - name: "setup PHP"
         uses: "shivammathur/setup-php@v2"
         with:
-          php-version: "8.1"
+          php-version: "8.3"
+          extensions: "json"
+          tools: "composer:v2"
+          cache: "composer"
       - name: "install composer dependencies"
-        run: "composer install --prefer-dist --no-progress"
+        run: "composer install --prefer-dist --no-interaction --no-progress"
       - name: "check PHP_CodeSniffer version"
         run: "vendor/bin/phpcs --version"
       - name: "PHP CodeSniffer"

composer.json

@@ -29,6 +29,14 @@
       "phpsap\\interfaces\\": "src/"
     }
   },
+  "scripts": {
+    "ci": [
+      "@composer validate --strict",
+      "@php -l src/",
+      "@php vendor/bin/phpstan analyse --configuration=phpstan.neon",
+      "@php vendor/bin/phpcs"
+    ]
+  },
   "require-dev": {
     "phpstan/phpstan": "^2.2",
     "squizlabs/php_codesniffer": "^4.0"