Github Action : Roave BC Check

PHPOffice · Nov 30, 2023 · 0b9a7dd · 0b9a7dd
1 parent e76b701
commit 0b9a7dd
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -163,3 +163,13 @@ jobs:
           wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.3/php-coveralls.phar
           chmod +x php-coveralls.phar
           php php-coveralls.phar --coverage_clover=build/clover.xml --json_path=build/coveralls-upload.json -vvv
+
+  roave-backwards-compatibility-check:
+    name: Roave Backwards Compatibility Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: "Check for BC breaks"
+        run: docker run -u $(id -u) -v $(pwd):/app nyholm/roave-bc-check-ga
diff --git a/docs/changes/1.x/1.2.0.md b/docs/changes/1.x/1.2.0.md
@@ -61,7 +61,16 @@
 - Bump tecnickcom/tcpdf from 6.6.2 to 6.6.5 by [@dependabot](https://github.com/dependabot) in [#2482](https://github.com/PHPOffice/PHPWord/pull/2482)
 - Bump phpmd/phpmd from 2.13.0 to 2.14.1 by [@dependabot](https://github.com/dependabot) in [#2483](https://github.com/PHPOffice/PHPWord/pull/2483)
 - Bump phpstan/phpstan-phpunit from 1.3.14 to 1.3.15 by [@dependabot](https://github.com/dependabot) in [#2494](https://github.com/PHPOffice/PHPWord/pull/2494)
-
+- Github Action : Roave BC Check by [@Progi1984](https://github/Progi1984) in [#](https://github.com/PHPOffice/PHPWord/pull/)
 
 ### BC Breaks
-- Removed dependency `laminas/laminas-escaper`
+- Removed dependency `laminas/laminas-escaper`
+- Changed: The return type of PhpOffice\PhpWord\Metadata\Settings#getThemeFontLang() changed from no type to PhpOffice\PhpWord\Style\Language|null
+- Changed: The return type of PhpOffice\PhpWord\Metadata\Settings#setThemeFontLang() changed from void to the non-covariant self
+- Changed: The return type of PhpOffice\PhpWord\Metadata\Settings#setThemeFontLang() changed from void to self
+- Changed: The parameter $themeFontLang of PhpOffice\PhpWord\Metadata\Settings#setThemeFontLang() changed from no type to a non-contravariant PhpOffice\PhpWord\Style\Language
+- Changed: The parameter $themeFontLang of PhpOffice\PhpWord\Metadata\Settings#setThemeFontLang() changed from no type to PhpOffice\PhpWord\Style\Language
+- Changed: The number of required arguments for PhpOffice\PhpWord\Style\Indentation#setLeft() increased from 0 to 1
+- Changed: The number of required arguments for PhpOffice\PhpWord\Style\Indentation#setRight() increased from 0 to 1
+- Changed: The number of required arguments for PhpOffice\PhpWord\Style\Indentation#setFirstLine() increased from 0 to 1
+- Changed: The number of required arguments for PhpOffice\PhpWord\Shared\Html::mapAlign() increased from 1 to 2
diff --git a/roave-bc-check.yaml b/roave-bc-check.yaml
@@ -0,0 +1,12 @@
+parameters:
+    ignoreErrors:
+      # 1.2.0
+        - '#\[BC\] CHANGED\: The return type of PhpOffice\\PhpWord\\Metadata\\Settings\#getThemeFontLang\(\) changed from no type to PhpOffice\\PhpWord\\Style\\Language|null#'
+        - '#\[BC\] CHANGED\: The return type of PhpOffice\\PhpWord\\Metadata\\Settings\#setThemeFontLang\(\) changed from void to self#'
+        - '#\[BC\] CHANGED\: The return type of PhpOffice\\PhpWord\\Metadata\\Settings\#setThemeFontLang\(\) changed from void to the non-covariant self#'
+        - '#\[BC\] CHANGED\: The parameter \$themeFontLang of PhpOffice\\PhpWord\\Metadata\\Settings\#setThemeFontLang\(\) changed from no type to a non-contravariant PhpOffice\\PhpWord\\Style\\Language#'
+        - '#\[BC\] CHANGED\: The parameter \$themeFontLang of PhpOffice\\PhpWord\\Metadata\\Settings\#setThemeFontLang\(\) changed from no type to PhpOffice\\PhpWord\\Style\\Language#'
+        - '#\[BC\] CHANGED\: The number of required arguments for PhpOffice\\PhpWord\\Style\\Indentation\#setLeft\(\) increased from 0 to 1#'
+        - '#\[BC\] CHANGED\: The number of required arguments for PhpOffice\\PhpWord\\Style\\Indentation\#setRight\(\) increased from 0 to 1#'
+        - '#\[BC\] CHANGED\: The number of required arguments for PhpOffice\\PhpWord\\Style\\Indentation\#setFirstLine\(\) increased from 0 to 1#'
+        - '#\[BC\] CHANGED\: The number of required arguments for PhpOffice\\PhpWord\\Shared\\Html\:\:mapAlign\(\) increased from 1 to 2#'