DOCSP-42819: add coding standards workflow

.github/actions/setup/action.yml

@@ -0,0 +1,52 @@
+name: Setup
+description: Sets up the build environment
+inputs:
+  php-version:
+    description: "PHP version to install"
+    required: true
+  driver-version:
+    description: "MongoDB extension version to install"
+    required: true
+  php-ini-values:
+    description: "INI values to pass along to setup-php action"
+    required: false
+    default: ""
+
+runs:
+  using: composite
+  steps:
+    - name: Setup cache environment
+      id: extcache
+      uses: shivammathur/cache-extensions@v1
+      with:
+        php-version: ${{ inputs.php-version }}
+        extensions: "mongodb-${{ inputs.driver-version }}"
+        key: "extcache-v1"
+
+    - name: Cache extensions
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.extcache.outputs.dir }}
+        key: ${{ steps.extcache.outputs.key }}
+        restore-keys: ${{ steps.extcache.outputs.key }}
+
+    - name: Install PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        coverage: none
+        extensions: "mongodb-${{ inputs.driver-version }}"
+        php-version: "${{ inputs.php-version }}"
+        tools: cs2pr
+        ini-values: "${{ inputs.php-ini-values }}"
+
+    - name: Show driver information
+      run: "php --ri mongodb"
+      shell: bash
+
+    - name: Install dependencies with Composer
+      uses: ramsey/[email protected]
+      with:
+        # Revert when psalm supports PHP 8.4
+        # composer-options: "--no-suggest"
+        composer-options: "--no-suggest ${{ inputs.php-version == '8.4'
+        && '--ignore-platform-req=php+' || '' }}"

.github/workflows/coding-standards.yml

@@ -0,0 +1,32 @@
+name: "Coding Standards"
+
+on:
+  pull_request:
+    paths:
+      - "source/**/*.php"
+      - ".github/workflows/*.yml"
+
+env:
+  PHP_VERSION: "8.2"
+  # TODO: change to "stable" once 1.20.0 is released
+  # DRIVER_VERSION: "stable"
+  DRIVER_VERSION: "mongodb/mongo-php-driver@master"
+
+jobs:
+  phpcs:
+    name: "phpcs"
+    runs-on: "ubuntu-22.04"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+
+      - name: "Setup"
+        uses: "./.github/actions/setup"
+        with:
+          php-version: ${{ env.PHP_VERSION }}
+          driver-version: ${{ env.DRIVER_VERSION }}
+
+      # The -q option is required until phpcs v4 is released
+      - name: "Run PHP_CodeSniffer"
+        run: "vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr"

.github/workflows/static-analysis.yml

@@ -0,0 +1,58 @@
+name: "Static Analysis"
+
+on:
+  pull_request:
+    paths:
+      - "source/**/*.php"
+      - ".github/workflows/*.yml"
+  workflow_call:
+    inputs:
+      ref:
+        description: "The git ref to check"
+        type: string
+        required: true
+
+env:
+  PHP_VERSION: "8.2"
+  # TODO: change to "stable" once 1.20.0 is released
+  # DRIVER_VERSION: "stable"
+  DRIVER_VERSION: "mongodb/mongo-php-driver@master"
+
+jobs:
+  psalm:
+    name: "Psalm"
+    runs-on: "ubuntu-22.04"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+        with:
+          ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || github.ref }}
+
+      - name: "Get SHA hash of checked out ref"
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
+          echo CHECKED_OUT_SHA=$(git rev-parse HEAD) >> $GITHUB_ENV
+
+      - name: "Setup"
+        uses: "./.github/actions/setup"
+        with:
+          php-version: ${{ env.PHP_VERSION }}
+          driver-version: ${{ env.DRIVER_VERSION }}
+
+      - name: "Run Psalm"
+        run: "vendor/bin/psalm --show-info=false --stats --output-format=github --threads=$(nproc) --report=psalm.sarif"
+
+      - name: "Upload SARIF report"
+        if: ${{ github.event_name != 'workflow_dispatch' }}
+        uses: "github/codeql-action/upload-sarif@v3"
+        with:
+          sarif_file: psalm.sarif
+
+      - name: "Upload SARIF report"
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        uses: "github/codeql-action/upload-sarif@v3"
+        with:
+          sarif_file: psalm.sarif
+          ref: ${{ inputs.ref }}
+          sha: ${{ env.CHECKED_OUT_SHA }}

composer.json

@@ -0,0 +1,12 @@
+{
+  "name": "mongodb/docs-php-library",
+  "description": "MongoDB PHP Library Documentation",
+  "require": {
+    "mongodb/mongodb": "^1.19"
+  },
+  "require-dev": {
+    "doctrine/coding-standard": "^12.0",
+    "squizlabs/php_codesniffer": "^3.7",
+    "vimeo/psalm": "^5.13"
+  }
+}