From 77cd578978a8e28a9b83d537221f773c5e934cda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=B6ller?= Date: Tue, 12 Dec 2023 14:10:38 +0100 Subject: [PATCH] Enhancement: Synchronize with ergebnis/php-package-template --- .github/CONTRIBUTING.md | 22 +++++++++++----------- .github/workflows/integrate.yaml | 6 ++++-- README.md | 20 ++++++++++---------- composer.json | 3 +++ composer.lock | 5 ++++- 5 files changed, 32 insertions(+), 24 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4cc7edf..e76ef78 100644 --- a/.github/CONTRIBUTING.md +++ b/.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: @@ -12,9 +12,9 @@ For details, take a look at the following workflow configuration files: ## 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 @@ -24,7 +24,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 @@ -36,7 +36,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 @@ -48,7 +48,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 @@ -60,7 +60,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 @@ -72,7 +72,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 @@ -84,7 +84,7 @@ to run a security analysis. ## Static Code Analysis -We are using [`phpstan/phpstan`](https://github.com/phpstan/phpstan) and [`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 @@ -94,7 +94,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 @@ -108,7 +108,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 diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml index 7319d07..dca0bd4 100644 --- a/.github/workflows/integrate.yaml +++ b/.github/workflows/integrate.yaml @@ -423,6 +423,7 @@ jobs: timeout-minutes: 5 strategy: + fail-fast: false matrix: php-version: - "7.4" @@ -466,8 +467,9 @@ jobs: key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}" restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-" - - name: "Remove incompatible dependencies with composer" - run: "composer remove ergebnis/composer-normalize --ansi --dev --no-interaction --no-progress" + - 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/install@1.8.0" diff --git a/README.md b/README.md index 7b88ea5..4802091 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ [![Total Downloads](https://poser.pugx.org/ergebnis/data-provider/downloads)](https://packagist.org/packages/ergebnis/data-provider) [![Monthly Downloads](http://poser.pugx.org/ergebnis/data-provider/d/monthly)](https://packagist.org/packages/ergebnis/data-provider) -This package provides generic data providers for use with [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit). +This project provides a [`composer`](https://getcomposer.org) package with generic data providers for use with [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit). ## Installation @@ -144,35 +144,35 @@ For examples, see [`Ergebnis\DataProvider\Test\Unit\UuidProviderTest`](test/Unit ## 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:am@localheinz.com?subject=ergebnis/data-provider:%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:am@localheinz.com?subject=ergebnis/data-provider:%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 diff --git a/composer.json b/composer.json index e700801..560948f 100644 --- a/composer.json +++ b/composer.json @@ -52,6 +52,9 @@ "audit": { "abandoned": "report" }, + "platform": { + "php": "7.4.33" + }, "preferred-install": "dist", "sort-packages": true }, diff --git a/composer.lock b/composer.lock index 96c098d..09141ee 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "ce8a6af215ef951da6019742fba7ef14", + "content-hash": "88a435918769518ee46d5d4daad2f7ea", "packages": [ { "name": "fakerphp/faker", @@ -6291,5 +6291,8 @@ "php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0" }, "platform-dev": [], + "platform-overrides": { + "php": "7.4.33" + }, "plugin-api-version": "2.6.0" }