docs: Upgrade Guide.

LastDragon-ru · Jan 5, 2024 · 58719df · 58719df
1 parent baeb081
commit 58719df
Show file tree

Hide file tree

Showing 24 changed files with 503 additions and 1 deletion.
diff --git a/docs/Shared/Upgrade.md b/docs/Shared/Upgrade.md
@@ -0,0 +1,20 @@
+## 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. |
+|:--:|---------------------------------------------------------------------------------------------------------------------|
diff --git a/docs/Shared/Upgrade/FromV5.md b/docs/Shared/Upgrade/FromV5.md
@@ -0,0 +1 @@
+- [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
diff --git a/docs/Shared/Upgrading.md b/docs/Shared/Upgrading.md
@@ -0,0 +1,3 @@
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "license": "MIT",
   "scripts": {
     "release": "release-it --config=.release-it/config.js",
-    "markdownlint": "npx markdownlint-cli --ignore-path=.gitignore --ignore=./docs/Shared/Links.md ."
+    "markdownlint": "npx markdownlint-cli --ignore-path=.gitignore --ignore=./docs/Shared ."
   },
   "repository": {
     "url": "https://github.com/LastDragon-ru/lara-asp"

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -40,6 +40,16 @@ composer require lastdragon-ru/lara-asp-core
 
 Please see the [source code](./src) to find something interesting 😅
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)

diff --git a/packages/core/UPGRADE.md b/packages/core/UPGRADE.md
@@ -0,0 +1,38 @@
+# Upgrade Guide
+
+[include:file]: ../../docs/Shared/Upgrade.md
+[//]: # (start: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+[//]: # (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: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+
+# Upgrade from v5
+
+[include:file]: ../../docs/Shared/Upgrade/FromV5.md
+[//]: # (start: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+* [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
+
+[//]: # (end: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
diff --git a/packages/documentator/README.md b/packages/documentator/README.md
@@ -56,6 +56,16 @@ Generates a table with the required versions of PHP/Laravel in Markdown format.
 
 [//]: # (end: 3183e17484393f086cbec523de70a97446749151d781d55ef8f480075e5c75b9)
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)

diff --git a/packages/documentator/UPGRADE.md b/packages/documentator/UPGRADE.md
@@ -0,0 +1,42 @@
+# Upgrade Guide
+
+[include:file]: ../../docs/Shared/Upgrade.md
+[//]: # (start: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+[//]: # (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: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+
+# Upgrade from v5
+
+[include:file]: ../../docs/Shared/Upgrade/FromV5.md
+[//]: # (start: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+* [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
+
+[//]: # (end: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+
+* [ ] Replace `LastDragon_ru\LaraASP\Documentator\Preprocessor\InstructionContract` by `LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ProcessableInstruction` or `LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction`.
+
+* [ ] Use [`Illuminate\Support\Facades\Process`](https://laravel.com/docs/processes) instead of `LastDragon_ru\LaraASP\Documentator\Utils\Process`.
diff --git a/packages/eloquent/README.md b/packages/eloquent/README.md
@@ -98,6 +98,16 @@ foreach ($query->getChangeSafeIterator() as $user) {
 | `getChunkedIterator()`                  | Return [`ChunkedIterator`](./src/Iterators/ChunkedIterator.php) instance.                     |
 | `getChangeSafeIteratorIterator()`       | Return [`ChunkedChangeSafeIterator`](./src/Iterators/ChunkedChangeSafeIterator.php) instance. |
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)

diff --git a/packages/eloquent/UPGRADE.md b/packages/eloquent/UPGRADE.md
@@ -0,0 +1,38 @@
+# Upgrade Guide
+
+[include:file]: ../../docs/Shared/Upgrade.md
+[//]: # (start: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+[//]: # (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: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+
+# Upgrade from v5
+
+[include:file]: ../../docs/Shared/Upgrade/FromV5.md
+[//]: # (start: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+* [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
+
+[//]: # (end: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
diff --git a/packages/formatter/README.md b/packages/formatter/README.md
@@ -222,6 +222,16 @@ The `$locale->duration(1234543)` is:
 
 [//]: # (end: bb574f6b1315aa7b33a56d897b23ecc4d18dece9ea201b85b54154e144931d3b)
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)

diff --git a/packages/formatter/UPGRADE.md b/packages/formatter/UPGRADE.md
@@ -0,0 +1,40 @@
+# Upgrade Guide
+
+[include:file]: ../../docs/Shared/Upgrade.md
+[//]: # (start: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+[//]: # (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: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+
+# Upgrade from v5
+
+[include:file]: ../../docs/Shared/Upgrade/FromV5.md
+[//]: # (start: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+* [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
+
+[//]: # (end: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+
+* [ ] If you are passing `\IntlDateFormatter::*` constants as `$format` argument for `Formatter::time()`/`Formatter::date()`/`Formatter::datetime()`, add a new custom format(s) which will refer to `\IntlDateFormatter::*` constant(s).
diff --git a/packages/graphql-printer/README.md b/packages/graphql-printer/README.md
@@ -226,6 +226,16 @@ Package also provides few great [GraphQL Assertions](./src/Testing/GraphQLAssert
 | `assertGraphQLPrintableEquals`  | Prints and compares two GraphQL schemas/types/nodes/etc.  |
 | `assertGraphQLExportableEquals` | Exports and compares two GraphQL schemas/types/nodes/etc. |
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)

diff --git a/packages/graphql-printer/UPGRADE.md b/packages/graphql-printer/UPGRADE.md
@@ -0,0 +1,28 @@
+# Upgrade Guide
+
+[include:file]: ../../docs/Shared/Upgrade.md
+[//]: # (start: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+[//]: # (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: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
diff --git a/packages/graphql/README.md b/packages/graphql/README.md
@@ -514,6 +514,16 @@ There are also few great new [GraphQL Assertions](./src/Testing/GraphQLAssertion
 |-----------------------------|--------------------------|
 | `assertGraphQLSchemaEquals` | Compares default schema. |
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)

diff --git a/packages/graphql/UPGRADE.md b/packages/graphql/UPGRADE.md
@@ -0,0 +1,38 @@
+# Upgrade Guide
+
+[include:file]: ../../docs/Shared/Upgrade.md
+[//]: # (start: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+[//]: # (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: c70a9a43c0a80bd2e7fa6010a9b2c0fbcab4cb4d536d7a498216d9df7431f7e2)
+
+# Upgrade from v5
+
+[include:file]: ../../docs/Shared/Upgrade/FromV5.md
+[//]: # (start: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+* [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
+
+[//]: # (end: fd146cf51ef5a8d9d13e0317c09860f472c63cb3d60d02f4d95deb3e12cae73d)
diff --git a/packages/migrator/README.md b/packages/migrator/README.md
@@ -98,6 +98,16 @@ class MySeeder extends RawSeeder {
 }
 ```
 
+[include:file]: ../../docs/Shared/Upgrading.md
+[//]: # (start: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+[//]: # (warning: Generated automatically. Do not edit.)
+
+# Upgrading
+
+Please follow [Upgrade Guide](UPGRADE.md).
+
+[//]: # (end: e9139abedb89f69284102c9112b548fd7add07cf196259916ea4f1c98977223b)
+
 [include:file]: ../../docs/Shared/Contributing.md
 [//]: # (start: 057ec3a599c54447e95d6dd2e9f0f6a6621d9eb75446a5e5e471ba9b2f414b89)
 [//]: # (warning: Generated automatically. Do not edit.)