Backporting changes from shish

.devcontainer/Dockerfile

@@ -0,0 +1,6 @@
+FROM debian:stable
+ARG DEBIAN_FRONTEND=noninteractive
+ARG XDEBUG_MODE=coverage
+RUN apt update -y && apt install -y git composer php-cli php-dom php-curl php-xdebug vim
+WORKDIR /app
+CMD cd /app/generator/doc && ./update.sh && cd /app/generator && composer install && php ./safe.php generate && composer cs-fix

.devcontainer/build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd $(dirname $0)/../
+docker run --rm -v ${PWD}:/app $(docker build -q -f .devcontainer/Dockerfile .)

.devcontainer/devcontainer.json

@@ -0,0 +1,10 @@
+{
+	"name": "Safe PHP",
+	"build": {
+		"context": "..",
+		"dockerfile": "./Dockerfile"
+	},
+
+	"workspaceMount": "source=${localWorkspaceFolder},target=/app,type=bind",
+	"workspaceFolder": "/app"
+}

.devcontainer/run.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd $(dirname $0)/../
+docker run --rm -ti -v ${PWD}:/app $(docker build -q . -f .devcontainer/Dockerfile) /bin/bash

.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: shish # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: shish2k # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+    -
+        package-ecosystem: composer
+        directory: "/"
+        schedule:
+            interval: weekly
+        versioning-strategy: auto
+        groups:
+            dev-dependencies:
+                dependency-type: "development"

.github/workflows/auto-regenerate.yml

@@ -4,30 +4,31 @@ name: "Auto Regenerate"
 on:
   schedule:
     - cron:  '0 3 * * *'
+  workflow_dispatch:
 
 jobs:
 
   auto-regenerate:
-    name: "Tries to regenerate the files"
-    runs-on: "ubuntu-latest"
+    name: "Auto Regenerate"
+    runs-on: "ubuntu-24.04"
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
 
       - name: "Install PHP with extensions"
         uses: "shivammathur/setup-php@v2"
         with:
           coverage: "pcov"
-          php-version: "8.0"
+          php-version: "8.3"
 
       - name: "Check out salathe/phpdoc-base"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
         with:
           path: "generator/doc/doc-en/doc-base"
           repository: "salathe/phpdoc-base"
 
       - name: "Check out php/doc-en"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
         with:
           path: "generator/doc/doc-en/en"
           repository: "php/doc-en"
@@ -43,33 +44,19 @@ jobs:
         run: "composer dump-autoload"
 
       - name: "Regenerate files"
-        run: "./safe.php generate"
+        id: regen
+        run: "./safe.php generate && git diff --exit-code && (echo regen=no-diff >> $GITHUB_OUTPUT) || (echo regen=diff >> $GITHUB_OUTPUT)"
         working-directory: "generator"
 
-      - name: "Check if regenerated files are different"
-        run: |
-          if output=$(git status --porcelain) && [ -z "$output" ]; then
-            # all is good
-            echo "Generated files are the same as committed file: OK"
-          else
-            # Uncommitted changes
-            echo "Generated files are different from commited files. Please run './safe.php generate' command and commit the results."
-            echo "Detected changes:"
-            git status
-            git diff
-            echo "Generated files are different from commited files. Please run './safe.php generate' command and commit the results."
-            exit 1;
-          fi
-
       - name: "Create a pr if the files are different"
-        if: ${{ failure() }}
-        uses: peter-evans/create-pull-request@v3
+        if: "${{ steps.regen.outputs.regen == 'diff' }}"
+        uses: peter-evans/create-pull-request@v6
         with:
           commit-message: "Automatically regenerate the files"
           branch: create-pull-request/regenerate-files
           title: "Automatically regenerate the files"
           labels: "regenerate, auto"
-          assignees: "kharhamel, moufmouf"
+          assignees: "shish"
 
 
-
+

.github/workflows/continuous-integration.yml

@@ -1,124 +1,182 @@
-# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
-
-name: "Continuous Integration"
+name: "Tests"
 
 on:
-  - "pull_request"
-  - "push"
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - 'v*'
+  pull_request:
 
 jobs:
-
-  continuous-integration:
-    name: "Continuous Integration"
-
-    runs-on: "ubuntu-latest"
-
-    strategy:
-      matrix:
-        php-version:
-          - "8.0"
-
-        dependencies:
-          - "highest"
-
+  fetch_defs:
+    name: "Fetch Definitions"
+    runs-on: "ubuntu-24.04"
+    outputs:
+      date: ${{ steps.date.outputs.date }}
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
-
-      - name: "Install PHP with extensions"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "pcov"
-          php-version: "${{ matrix.php-version }}"
-
+        uses: "actions/checkout@v4"
       - name: "Get current date for the daily cache"
         id: 'date'
-        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
-
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
       - name: "Cache the php documentation"
         id: cache-php-doc
-        uses: "actions/cache@v1"
+        uses: "actions/cache@v4"
         with:
           path: "generator/doc/doc-en"
           key: php-doc-${{ steps.date.outputs.date }}
-
       - name: "Check out salathe/phpdoc-base"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
         if: steps.cache-php-doc.outputs.cache-hit != 'true'
         with:
           path: "generator/doc/doc-en/doc-base"
           repository: "salathe/phpdoc-base"
-
       - name: "Check out php/doc-en"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
         if: steps.cache-php-doc.outputs.cache-hit != 'true'
         with:
           path: "generator/doc/doc-en/en"
           repository: "php/doc-en"
 
+  generator_tests:
+    name: "Generator Tests"
+    runs-on: "ubuntu-24.04"
+    needs: "fetch_defs"
+    strategy:
+      matrix:
+        php-version:
+          - "8.2"
+          - "8.3"
+          - "8.4"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+      - name: "Install PHP with extensions"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "pcov"
+          php-version: "${{ matrix.php-version }}"
+      - name: "Fetch cached docs"
+        id: cache-php-doc
+        uses: "actions/cache@v4"
+        with:
+          path: "generator/doc/doc-en"
+          key: php-doc-${{ needs.fetch_defs.outputs.date }}
       - name: "Cache dependencies installed with composer"
-        uses: "actions/cache@v1"
+        uses: "actions/cache@v4"
         with:
           path: "~/.composer/cache"
-          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('**/composer.lock') }}"
-          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
-
+          key: "php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-"
       - name: "Install dependencies with composer in generator/ directory"
         run: "composer install --no-interaction"
         working-directory: "generator"
-
-      - name: "Install dependencies with composer in root directory"
-        run: "composer install --no-interaction"
-
-      - name: "Run tests with phpunit/phpunit in root directory"
-        run: "vendor/bin/phpunit"
-
       - name: "Run tests with phpunit/phpunit in generator/ directory"
         run: "vendor/bin/phpunit"
         working-directory: "generator"
-
       - name: "Run coding standard checks with squizlabs/php_codesniffer in generator/ directory"
         run: "composer cs-check"
         working-directory: "generator"
-
       - name: "Run static code analysis with phpstan/phpstan in generator/ directory"
         run: "composer phpstan"
         working-directory: "generator"
+      - name: "Run static code analysis with rector/rector in generator/ directory"
+        run: "composer rector --dry-run"
+        working-directory: "generator"
 
+  generated_tests:
+    name: "Generated Tests"
+    runs-on: "ubuntu-24.04"
+    needs: "fetch_defs"
+    strategy:
+      matrix:
+        php-version:
+          - "8.2"
+          - "8.3"
+          - "8.4"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+      - name: "Install PHP with extensions"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "pcov"
+          php-version: "${{ matrix.php-version }}"
+      - name: "Fetch cached docs"
+        id: cache-php-doc
+        uses: "actions/cache@v4"
+        with:
+          path: "generator/doc/doc-en"
+          key: php-doc-${{ needs.fetch_defs.outputs.date }}
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/cache@v4"
+        with:
+          path: "~/.composer/cache"
+          key: "php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-"
+      - name: "Install dependencies with composer in root directory"
+        run: "composer install --no-interaction"
+      - name: "Run tests with phpunit/phpunit in root directory"
+        run: "vendor/bin/phpunit"
       - name: "Dump autoloader with composer in root directory"
         run: "composer dump-autoload"
-
       - name: "Run coding standard checks with squizlabs/php_codesniffer in root directory"
         run: "composer cs-check"
-
       - name: "Run static code analysis with phpstan/phpstan in root directory"
         run: "composer phpstan"
 
-      - name: "Regenerate files"
-        run: "./safe.php generate"
+  check_sync:
+    name: "Check Sync"
+    runs-on: "ubuntu-24.04"
+    needs: "fetch_defs"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+      - name: "Install PHP with extensions"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "pcov"
+          php-version: "8.4"
+      - name: "Fetch cached docs"
+        id: cache-php-doc
+        uses: "actions/cache@v4"
+        with:
+          path: "generator/doc/doc-en"
+          key: php-doc-${{ needs.fetch_defs.outputs.date }}
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/cache@v4"
+        with:
+          path: "~/.composer/cache"
+          key: "php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-"
+      - name: "Install dependencies with composer in generator/ directory"
+        run: "composer install --no-interaction"
+        working-directory: "generator"
+      - name: "Install dependencies with composer in root directory"
+        run: "composer install --no-interaction"
+      - name: "Regenerate files and check for differences"
+        run: "./safe.php generate && git diff --exit-code"
         working-directory: "generator"
 
-      - name: "Check if regenerated files are different"
-        run: |
-          if output=$(git status --porcelain) && [ -z "$output" ]; then
-            # all is good
-            echo "Generated files are the same as committed file: OK"
-          else
-            # Uncommitted changes
-            echo "Generated files are different from commited files. Please run './safe.php generate' command and commit the results."
-            echo "Detected changes:"
-            git status
-            git diff
-            echo "Generated files are different from commited files. Please run './safe.php generate' command and commit the results."
-            exit 1;
-          fi
-
-      - name: "Archive code coverage results"
-        uses: "actions/upload-artifact@v1"
+  rector:
+    name: "Rector Tests"
+    runs-on: "ubuntu-24.04"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+      - name: "Install PHP with extensions"
+        uses: "shivammathur/setup-php@v2"
         with:
-          name: "build"
-          path: "generator/build"
+          php-version: "8.4"
+      - name: "Composer install"
+        run: "composer install && composer rector && composer test"
+        working-directory: "generator/tests/rector"
+      - name: "Run rector"
+        run: "composer rector"
+        working-directory: "generator/tests/rector"
+      - name: "Run tests"
+        run: "composer test"
+        working-directory: "generator/tests/rector"
 
-      - uses: codecov/codecov-action@v1 # upload the coverage to codecov
-        with:
-          fail_ci_if_error: true # optional (default = false)