diff --git a/README.md b/README.md index 69e37a9da..94dcdb256 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,18 @@ The set provides best practices to make development more fun and classes/service # Installation -```shell -# Everything -composer require lastdragon-ru/lara-asp +Installation of the root `lastdragon-ru/lara-asp` package is not recommended because it will install all packages, but some of them are intended to use while dev only (and may want dependencies like `phpunit`/`phpstan`/etc). So select the desired package and install it. You can find requirements and installation instructions (if any) inside package documentation. -# Specific package (where "core" the package name) -composer require lastdragon-ru/lara-asp-core +```shell +# General case (where "" the package name). +composer require lastdragon-ru/lara-asp- ``` # Packages +| 🐝 | Package intended to use in dev. | +|:--:|---------------------------------| + [include:package-list]: ./packages [//]: # (start: df3ee6374fabefbdeb79b26164b3f2ef88f6ed94646bb5d44751ea6da758de19) [//]: # (warning: Generated automatically. Do not edit.) @@ -93,7 +95,7 @@ This package provides a customizable wrapper around the [Symfony Serializer Comp [Read more](). -## Testing Helpers +## Testing Helpers 🐝 This package provides various useful asserts for [PHPUnit](https://phpunit.de/) and alternative solution for HTTP tests - testing HTTP response has never been so easy! And this not only about `TestResponse` but any PSR response 😎 diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 000000000..cb3fc9758 --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,51 @@ +# Upgrade Guide + +[include:file]: ./docs/Shared/Upgrade.md +[//]: # (start: 39d35167e0d4cea1b3b411d449b79f0b6df5fcbf65c5d8b9775671fe5603b7c9) +[//]: # (warning: Generated automatically. Do not edit.) + +## Instructions + +1. Determine the current version (`composer info ...`) +2. Choose the wanted version +3. Follow the instructions +4. ?????? +5. PROFIT + +For example, if the current version is `2.x` and you want to migrate to `5.x`, you need to perform all steps in the following order: + +* "Upgrade from v2" +* "Upgrade from v3" +* "Upgrade from v4" + +Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases) to find all changes. + +## Legend + +| 🤝 | Backward-compatible change. Please note that despite you can ignore it now, but it will be mandatory in the future. | +|:--:|---------------------------------------------------------------------------------------------------------------------| + +[//]: # (end: 39d35167e0d4cea1b3b411d449b79f0b6df5fcbf65c5d8b9775671fe5603b7c9) + +# Packages + +[include:package-list]: ./packages ({"template": "upgradable"}) +[//]: # (start: 39292ac87c6fc1ec1884b9449c69f39245874999bd085380a87c7473ffae043b) +[//]: # (warning: Generated automatically. Do not edit.) + +* [Core]() +* [Documentator]() +* [Eloquent Helpers]() +* [Formatter]() +* [GraphQL Extensions for Lighthouse]() +* [GraphQL Printer]() +* [Migrator]() +* [SPA Helpers]() +* [Serializer]() +* [Testing Helpers 🐝]() + +[//]: # (end: 39292ac87c6fc1ec1884b9449c69f39245874999bd085380a87c7473ffae043b) + +# Upgrade from v5 + +* [ ] Installation of the root `lastdragon-ru/lara-asp` package is not recommended anymore 🤝 diff --git a/docs/Shared/InstallationDev.md b/docs/Shared/InstallationDev.md new file mode 100644 index 000000000..a72d9161c --- /dev/null +++ b/docs/Shared/InstallationDev.md @@ -0,0 +1,9 @@ +# Installation + +> [!NOTE] +> +> The package intended to use in dev. + +```shell +composer require --dev lastdragon-ru/lara-asp-${package} +``` diff --git a/packages/documentator/defaults/views/package-list/upgrade.blade.php b/packages/documentator/defaults/views/package-list/upgradable.blade.php similarity index 100% rename from packages/documentator/defaults/views/package-list/upgrade.blade.php rename to packages/documentator/defaults/views/package-list/upgradable.blade.php diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest.php b/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest.php index 2ea6eca43..d1277d011 100644 --- a/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest.php +++ b/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest.php @@ -97,8 +97,8 @@ public function testProcessNoTitle(): void { */ public static function dataProviderProcess(): array { return [ - 'default' => ['~default.md', 'default'], - 'upgrade' => ['~upgrade.md', 'upgrade'], + 'default' => ['~default.md', 'default'], + 'upgradable' => ['~upgradable.md', 'upgradable'], ]; } // diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest~upgrade.md b/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest~upgradable.md similarity index 100% rename from packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest~upgrade.md rename to packages/documentator/src/Preprocessor/Instructions/IncludePackageList/InstructionTest~upgradable.md diff --git a/packages/testing/README.md b/packages/testing/README.md index 5d5b16815..cd1d3a40b 100644 --- a/packages/testing/README.md +++ b/packages/testing/README.md @@ -1,4 +1,4 @@ -# Testing Helpers +# Testing Helpers 🐝 This package provides various useful asserts for [PHPUnit](https://phpunit.de/) and alternative solution for HTTP tests - testing HTTP response has never been so easy! And this not only about `TestResponse` but any PSR response 😎 @@ -25,17 +25,21 @@ This package provides various useful asserts for [PHPUnit](https://phpunit.de/) [//]: # (end: 876a9177c0e8e3722ac84e8f3888245fc9070a64a87dedfe7c9d9ba2a13b374b) -[include:template]: ../../docs/Shared/Installation.md ({"data": {"package": "testing"}}) -[//]: # (start: 5a3ab424b5419398e67a76495351503570fa33421481357861dc96f3ac4d841d) +[include:template]: ../../docs/Shared/InstallationDev.md ({"data": {"package": "testing"}}) +[//]: # (start: 9c57d43303e5ef82308c0c83e328e2a47be808a50cd12d6fc5bcfd9229e2fa7c) [//]: # (warning: Generated automatically. Do not edit.) # Installation +> [!NOTE] +> +> The package intended to use in dev. + ```shell -composer require lastdragon-ru/lara-asp-testing +composer require --dev lastdragon-ru/lara-asp-testing ``` -[//]: # (end: 5a3ab424b5419398e67a76495351503570fa33421481357861dc96f3ac4d841d) +[//]: # (end: 9c57d43303e5ef82308c0c83e328e2a47be808a50cd12d6fc5bcfd9229e2fa7c) # Usage