Merge pull request #121 from TheDragonCode/4.x

andrey-helldar · web-flow · commit 597cca9fd106 · 2023-01-21T19:44:53.000+03:00
Update upgrade docs
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -36,7 +36,7 @@ module.exports = {
         editLink: true,
 
         navbar: [
-            { text: '3.x', link: '/prologue/changelog/index.md' }
+            { text: '4.x', link: '/prologue/changelog/4.x.md' }
         ],
 
         sidebarDepth: 1,
diff --git a/docs/index.md b/docs/index.md
@@ -14,7 +14,9 @@
 ## Table of contents
 
 * Prologue
-    * [Upgrade Guide](prologue/upgrade.md)
+    * [Upgrade Guide](prologue/upgrade-guide/index.md)
+      * [To 4.x from 3.x](prologue/upgrade-guide/4.x.md)
+      * [To 3.x from 2.x](prologue/upgrade-guide/3.x.md)
 * Getting Started
     * [Installation](getting-started/installation/index.md)
     * How to use
diff --git a/docs/prologue/changelog/4.x.md b/docs/prologue/changelog/4.x.md
@@ -4,6 +4,15 @@
 
 ### Changed
 
-- Coming soon
+- Project renamed from `Laravel Migration Actions` to `Laravel Actions` by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/108
+- Console commands have been renamed by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/110
+- `Names::MIGRATE` constant have been renamed to `Names::ACTIONS` by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/111
+- Refactored `actions:upgrade` console command by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/112
+- Renamed console class name by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/113
+- Database table name changed from `migration_actions` to `actions` by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/114
+- Changelog prepared for version 4 by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/115
+- Renamed `migrate` methods with `actions` by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/116
+- Added Events tests by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/117
+- Fixed conflict block by @andrey-helldar in https://github.com/TheDragonCode/laravel-actions/pull/120
 
 **Full Changelog**: https://github.com/TheDragonCode/laravel-actions/compare/v3.2.0...v4.0.0
diff --git a/docs/prologue/upgrade-guide/3.x.md b/docs/prologue/upgrade-guide/3.x.md
@@ -1,6 +1,6 @@
-# Upgrade Guide
+# Upgrading To 3.x from 2.x
 
-## High Impact Changes
+### High Impact Changes
 
 - [Change the location of the configuration file](#configuration)
 - [Replacing named classes with anonymous ones](#anonymous-classes)
@@ -11,13 +11,11 @@
 - Laravel 6.0 was dropped
 - Dragon Code: Contracts (`dragon-code/contracts`) was dropped
 
-## Medium Impact Changes
+### Medium Impact Changes
 
 - [Changing the name of an action column in the database](#changed-action-repository)
 - [Action storage directory changed](#actions-location)
 
-## Upgrading To 3.x from 2.x
-
 ### Call Upgrade Command
 
 > Note
@@ -37,35 +35,35 @@ It will do the following:
 - Replace named classes with anonymous ones
 - Create a configuration file according to the data saved in your project
 
-### Updating Dependencies
+## Updating Dependencies
 
-#### PHP 8.0.2 Required
+### PHP 8.0.2 Required
 
 Laravel Actions now requires PHP 8.0.2 or greater.
 
-#### Composer Dependencies
+### Composer Dependencies
 
 You should update the following dependency in your application's `composer.json` file:
 
 - `dragon-code/laravel-actions` to `^3.0`
 
-### Configuration
+## Configuration
 
 Publish the config file and migrate the settings from the `config/database.php` file to `config/actions.php`.
 
 ```bash
 php artisan vendor:publish --provider="DragonCode\LaravelActions\ServiceProvider"
 ```
 
-### Actions Location
+## Actions Location
 
 Move the action files to the `actions` folder in the project root, or update the `actions.path` option in the configuration file.
 
-### Parent Namespace
+## Parent Namespace
 
 Replace `DragonCode\LaravelActions\Support\Actionable` with `DragonCode\LaravelActions\Action`.
 
-### Anonymous Classes
+## Anonymous Classes
 
 Replace named calls to your application's classes with anonymous ones.
 
@@ -83,15 +81,15 @@ use DragonCode\LaravelActions\Action;
 return new class () extends Action {};
 ```
 
-### Invokable Method
+## Invokable Method
 
 If your class does not contain a `down` method, then you can replace the `up` method with `__invoke`.
 
-### Changed Action Repository
+## Changed Action Repository
 
 Just call the `php artisan migrate` command to make changes to the action repository table.
 
-### Changed Properties
+## Changed Properties
 
 Make sure all overridden properties are typed:
 
@@ -104,17 +102,17 @@ protected $except_environment    >>  protected string|array|null $exceptEnvironm
 protected $before                >>  protected bool $before
 ```
 
-### Added recursive search for actions in a folder
+## Added recursive search for actions in a folder
 
-#### Before:
+### Before:
 
 ```bash
 2022_10_13_013321_test1
 2022_10_13_013326_test2
 bar/2022_10_13_013323_test3 # will not be called
 ```
 
-#### After:
+### After:
 
 ```bash
 2022_10_13_013321_test1
diff --git a/docs/prologue/upgrade-guide/4.x.md b/docs/prologue/upgrade-guide/4.x.md
@@ -0,0 +1,78 @@
+# Upgrading To 4.x from 3.x
+
+### High Impact Changes
+
+- [Renamed project namespace](#renamed-project-namespace)
+- [Changing the names of console commands](#changing-the-names-of-console-commands)
+
+### Medium Impact Changes
+
+- [`Names::MIGRATE` constant name changed](#namesmigrate-constant-name-changed)
+
+### Low Impact Changes
+
+- [Changed the default name of the table for storing actions](#changed-the-default-name-of-the-table-for-storing-actions)
+
+## Renamed project namespace
+
+You should update the following dependency in your application's `composer.json` file:
+
+Replace:
+
+```json
+{
+    "require": {
+        "dragon-code/laravel-migration-actions": "^3.0"
+    }
+}
+```
+
+with
+
+```json
+{
+    "require": {
+        "dragon-code/laravel-actions": "^4.0"
+    }
+}
+```
+
+Then you need to update the dependencies:
+
+```bash
+composer update
+```
+
+## Changing the names of console commands
+
+| Old Name                               | New Name                       |
+|----------------------------------------|--------------------------------|
+| `php artisan make:migration:action`    | `php artisan make:action`      |
+| `php artisan migrate:actions`          | `php artisan actions`          |
+| `php artisan migrate:actions:install`  | `php artisan actions:install`  |
+| `php artisan migrate:actions:fresh`    | `php artisan actions:fresh`    |
+| `php artisan migrate:actions:refresh`  | `php artisan actions:refresh`  |
+| `php artisan migrate:actions:reset`    | `php artisan actions:reset`    |
+| `php artisan migrate:actions:rollback` | `php artisan actions:rollback` |
+| `php artisan migrate:actions:status`   | `php artisan actions:status`   |
+| `php artisan migrate:actions:upgrade`  | `php artisan actions:upgrade`  |
+
+## `Names::MIGRATE` constant name changed
+
+Replace
+
+```php
+DragonCode\LaravelActions\Constants\Names::MIGRATE
+```
+
+with
+
+```php
+DragonCode\LaravelActions\Constants\Names::ACTIONS
+```
+
+## Changed the default name of the table for storing actions
+
+The new table name is `actions`.
+
+You can also specify any name in the application [settings](https://github.com/TheDragonCode/laravel-actions/blob/main/config/actions.php).
diff --git a/docs/prologue/upgrade-guide/index.md b/docs/prologue/upgrade-guide/index.md
@@ -0,0 +1,4 @@
+# Upgrade Guide
+
+* [Upgrading To 4.x from 3.x](4.x.md)
+* [Upgrading To 3.x from 2.x](3.x.md)
