Enhancement: Run backward-compatibility analysis with roave/backward-…

…compatibility-check
ergebnis · Dec 12, 2023 · 6fc90cf · 6fc90cf
1 parent 79c4fc7
commit 6fc90cf
Show file tree

Hide file tree

Showing 7 changed files with 1,402 additions and 98 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -10,6 +10,18 @@ For details, take a look at the following workflow configuration files:
 - [`workflows/renew.yaml`](workflows/renew.yaml)
 - [`workflows/triage.yaml`](workflows/triage.yaml)
 
+## Backward-compatibility Analysis
+
+We use [`roave/backward-compatibility-check`](https://github.com/Roave/BackwardCompatibilityCheck) to prevent breaking backwards-compatibility.
+
+Run
+
+```sh
+make backward-compatibility-analysis
+```
+
+to run a backward-compatibility analysis.
+
 ## Coding Standards
 
 We use [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.

diff --git a/.github/settings.yml b/.github/settings.yml
@@ -14,6 +14,7 @@ branches:
         required_approving_review_count: 1
       required_status_checks:
         checks:
+          - context: "Backward-Compatibility Analysis (8.1, locked)"
           - context: "Code Coverage (8.1, locked)"
           - context: "Coding Standards (8.1, locked)"
           - context: "Dependency Analysis (8.1, locked)"

diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml
@@ -9,6 +9,61 @@ on: # yamllint disable-line rule:truthy
       - "main"
 
 jobs:
+  backward-compatibility-analysis:
+    name: "Backward-Compatibility Analysis"
+
+    runs-on: "ubuntu-latest"
+
+    timeout-minutes: 5
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.1"
+
+        dependencies:
+          - "locked"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+        with:
+          fetch-depth: 0
+
+      - name: "Set up PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          coverage: "none"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Set up problem matchers for PHP"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      - name: "Set up problem matchers for phpunit/phpunit"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
+
+      - name: "Validate composer.json and composer.lock"
+        run: "composer validate --ansi --strict"
+
+      - name: "Determine composer cache directory"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Install ${{ matrix.dependencies }} dependencies with composer"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+        with:
+          dependencies: "${{ matrix.dependencies }}"
+
+      - name: "Run backward-compatibility analysis with roave/backward-compatibility-check"
+        run: "vendor/bin/roave-backward-compatibility-check --ansi --format=github-actions --from=1902cc2"
+
   code-coverage:
     name: "Code Coverage"
 
@@ -32,7 +87,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "xdebug"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -100,7 +155,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -165,7 +220,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
           tools: "phive"
 
@@ -221,7 +276,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "xdebug"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -273,7 +328,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -335,7 +390,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -385,7 +440,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, opcache, pcntl, phar, posix, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, opcache, pcntl, phar, posix, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -449,7 +504,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"

diff --git a/.github/workflows/renew.yaml b/.github/workflows/renew.yaml
@@ -32,7 +32,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"

diff --git a/Makefile b/Makefile
@@ -1,6 +1,10 @@
 .PHONY: it
 it: refactoring coding-standards security-analysis static-code-analysis tests ## Runs the refactoring, coding-standards, security-analysis, static-code-analysis, and tests targets
 
+.PHONY: backward-compatibility-analysis
+backward-compatibility-analysis: vendor ## Runs a backward-compatibility analysis with roave/backward-compatibility-check
+	vendor/bin/roave-backward-compatibility-check --from=1902cc2
+
 .PHONY: code-coverage
 code-coverage: vendor ## Collects coverage from running unit tests with phpunit/phpunit
 	mkdir -p .build/phpunit/

diff --git a/composer.json b/composer.json
@@ -36,6 +36,7 @@
     "phpunit/phpunit": "^10.5.2",
     "psalm/plugin-phpunit": "~0.18.4",
     "rector/rector": "~0.18.12",
+    "roave/backward-compatibility-check": "^8.4.0",
     "vimeo/psalm": "^5.17.0"
   },
   "autoload": {