Enhancement: Synchronize with ergebnis/php-package-template

.github/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # CONTRIBUTING
 
-We are using [GitHub Actions](https://github.com/features/actions) as a continuous integration system.
+We use [GitHub Actions](https://github.com/features/actions) as a continuous integration system.
 
 For details, take a look at the following workflow configuration files:
 
@@ -11,11 +11,23 @@ For details, take a look at the following workflow configuration files:
 - [`workflows/triage.yaml`](workflows/triage.yaml)
 - [`workflows/update.yaml`](workflows/update.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 are using [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.
+We use [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.
 
-We are using [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
+We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
 
 If you do not have `yamllint` installed yet, run
 
@@ -25,7 +37,7 @@ brew install yamllint
 
 to install `yamllint`.
 
-We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to enforce coding standards in PHP files.
+We use [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to enforce coding standards in PHP files.
 
 Run
 
@@ -37,7 +49,7 @@ to automatically fix coding standard violations.
 
 ## Dependency Analysis
 
-We are using [`maglnet/composer-require-checker`](https://github.com/maglnet/ComposerRequireChecker) to prevent the use of unknown symbols in production code.
+We use [`maglnet/composer-require-checker`](https://github.com/maglnet/ComposerRequireChecker) to prevent the use of unknown symbols in production code.
 
 Run
 
@@ -49,7 +61,7 @@ to run a dependency analysis.
 
 ## Mutation Tests
 
-We are using [`infection/infection`](https://github.com/infection/infection) to ensure a minimum quality of the tests.
+We use [`infection/infection`](https://github.com/infection/infection) to ensure a minimum quality of the tests.
 
 Enable `Xdebug` and run
 
@@ -61,7 +73,7 @@ to run mutation tests.
 
 ## Refactoring
 
-We are using [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code.
+We use [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code.
 
 Run
 
@@ -73,7 +85,7 @@ to automatically refactor code.
 
 ## Security Analysis
 
-We are using [`composer`](https://github.com/composer/composer) to run a security analysis.
+We use [`composer`](https://github.com/composer/composer) to run a security analysis.
 
 Run
 
@@ -85,7 +97,7 @@ to run a security analysis.
 
 ## Static Code Analysis
 
-We are using [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
+We use [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
 
 Run
 
@@ -95,7 +107,7 @@ make static-code-analysis
 
 to run a static code analysis.
 
-We are also using the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file).
+We also use the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file).
 
 Run
 
@@ -109,7 +121,7 @@ to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml).
 
 ## Tests
 
-We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.
+We use [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.
 
 Run
 

.github/dependabot.yaml

@@ -3,13 +3,14 @@
 version: 2
 
 updates:
-  - commit-message:
+  - allow:
+      - dependency-type: "development"
+    commit-message:
       include: "scope"
       prefix: "composer"
     directory: "/"
     ignore:
       - dependency-name: "composer/composer"
-      - dependency-name: "composer-plugin-api"
     labels:
       - "dependency"
     open-pull-requests-limit: 10

.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: "Compile Phar (8.1, locked)"

.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 --install-development-dependencies"
+
   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 }}"
           tools: "phive"
 
@@ -175,7 +230,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           ini-values: "memory_limit=-1, phar.readonly=0"
           php-version: "${{ matrix.php-version }}"
           tools: "phive"
@@ -247,7 +302,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"
 
@@ -278,7 +333,7 @@ jobs:
           trust-gpg-keys: "0xC00543248C87FB13,0x033E5F8D801A2F8D,0x2DF45277AEF09A2F"
 
       - name: "Run maglnet/composer-require-checker"
-        run: ".phive/composer-require-checker check --ansi --config-file=$(pwd)/composer-require-checker.json"
+        run: ".phive/composer-require-checker check --ansi --config-file=$(pwd)/composer-require-checker.json --verbose"
 
   mutation-tests:
     name: "Mutation Tests"
@@ -303,7 +358,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"
@@ -355,7 +410,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"
@@ -417,7 +472,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"
@@ -467,7 +522,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"
@@ -525,7 +580,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"
@@ -547,6 +602,10 @@ jobs:
           key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
           restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
 
+      - name: "Remove platform configuration with composer"
+        if: "matrix.dependencies != 'locked'"
+        run: "composer config platform.php --ansi --unset"
+
       - name: "Install ${{ matrix.dependencies }} dependencies with composer"
         uses: "ergebnis/.github/actions/composer/[email protected]"
         with:

.github/workflows/release.yaml

@@ -38,7 +38,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, bcmath, ctype, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
           tools: "phive"
 

.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"

Makefile

@@ -3,6 +3,10 @@ COMPOSER_VERSION:=2.6.6
 .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 --install-development-dependencies
+
 .PHONY: code-coverage
 code-coverage: vendor ## Collects coverage from running unit and integration tests with phpunit/phpunit
 	mkdir -p .build/phpunit
@@ -17,7 +21,7 @@ coding-standards: phive vendor ## Lints YAML files with yamllint, normalizes com
 
 .PHONY: dependency-analysis
 dependency-analysis: phive vendor ## Runs a dependency analysis with maglnet/composer-require-checker
-	.phive/composer-require-checker check --config-file=$(shell pwd)/composer-require-checker.json
+	.phive/composer-require-checker check --config-file=$(shell pwd)/composer-require-checker.json --verbose
 
 .PHONY: help
 help: ## Displays this list of targets with descriptions

README.md

@@ -13,7 +13,7 @@
 [![Total Downloads](https://poser.pugx.org/ergebnis/composer-normalize/downloads)](https://packagist.org/packages/ergebnis/composer-normalize)
 [![Monthly Downloads](http://poser.pugx.org/ergebnis/composer-normalize/d/monthly)](https://packagist.org/packages/ergebnis/composer-normalize)
 
-This package provides a [`composer`](https://getcomposer.org) plugin for normalizing [`composer.json`](https://getcomposer.org/doc/04-schema.md).
+This project provides a [`composer`](https://getcomposer.org) plugin for normalizing [`composer.json`](https://getcomposer.org/doc/04-schema.md).
 
 [![Hmm, kinda cool I guess](https://user-images.githubusercontent.com/605483/150120621-1eb65e19-b924-481c-a9e5-e762f1f3cfc9.png)](https://github.com/laravel/laravel/pull/4856#issuecomment-439705243)
 
@@ -63,7 +63,7 @@ Head over to http://github.com/ergebnis/composer-normalize/releases/latest and d
 Run
 
 ```sh
-chmod +x composer-normalize.phar
+composer require ergebnis/composer-normalize
 ```
 
 to make the downloaded `composer-normalize.phar` executable.
@@ -488,35 +488,35 @@ index fd6461fc3..23c3a3596 100644
 
 ## Changelog
 
-The maintainers of this package record notable changes to this project in a [changelog](CHANGELOG.md).
+The maintainers of this project record notable changes to this project in a [changelog](CHANGELOG.md).
 
 ## Contributing
 
-The maintainers of this package suggest following the [contribution guide](.github/CONTRIBUTING.md).
+The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md).
 
 ## Code of Conduct
 
-The maintainers of this package ask contributors to follow the [code of conduct](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
+The maintainers of this project ask contributors to follow the [code of conduct](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
 
 ## General Support Policy
 
-The maintainers of this package provide limited support.
+The maintainers of this project provide limited support.
 
-You can support the maintenance of this package by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this package](mailto:[email protected]?subject=ergebnis/composer-normalize:%20Requesting%20invoice%20for%20services).
+You can support the maintenance of this project by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this project](mailto:[email protected]?subject=ergebnis/composer-normalize:%20Requesting%20invoice%20for%20services).
 
 ## PHP Version Support Policy
 
-This package supports PHP versions with [active support](https://www.php.net/supported-versions.php).
+This project supports PHP versions with [active and security support](https://www.php.net/supported-versions.php).
 
-The maintainers of this package add support for a PHP version following its initial release and drop support for a PHP version when it has reached its end of active support.
+The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
 
 ## Security Policy
 
-This package has a [security policy](.github/SECURITY.md).
+This project has a [security policy](.github/SECURITY.md).
 
 ## License
 
-This package uses the [MIT license](LICENSE.md).
+This project uses the [MIT license](LICENSE.md).
 
 ## Social