arborrow / montserrat

A retreat management application written in Laravel
12 stars 4 forks source link

Laravel 11.x Shift #565

Open arborrow opened 2 weeks ago

arborrow commented 2 weeks ago

This pull request includes the changes for upgrading to Laravel 11.x. Feel free to commit any additional changes to the shift-122401 branch.

Before merging, you need to:

If you need help with your upgrade, check out the Human Shifts.

arborrow commented 2 weeks ago

:information_source: To slim down the Laravel installation, Laravel 11 no longer has most of the core files previously included in the default Laravel application. While you are welcome to publish and customize these files, they are no longer required.

Shift takes an iterative approach to removing core files which are not customized or where its customizations may be done elsewhere in a modern Laravel 11 application. As such, you may see some commits removing files and others re-registering your customizations.

arborrow commented 2 weeks ago

:information_source: Laravel 11 no longer requires you to maintain the default configuration files. Your configuration now merges with framework defaults.

Shift streamlined your configuration files by removing options that matched the Laravel defaults and preserving your true customizations. These are values which are not changeable through ENV variables.

If you wish to keep the full set of configuration files, Shift recommends running artisan config:publish --all --force to get the latest configuration files from Laravel 11, then reapplying the customizations Shift streamlined.

arborrow commented 2 weeks ago

:information_source: Shift detected customized options within your configuration files which may be set with an ENV variable. To help keep your configuration files streamlined, you may set the following variables. Be sure adjust any values per environment.

APP_NAME=Polanco
APP_TIMEZONE=America/Chicago
BCRYPT_ROUNDS=10
CACHE_STORE=file
DB_CONNECTION=mysql
MAIL_MAILER=smtp
QUEUE_CONNECTION=sync
SESSION_DRIVER=file

Note: some of these may simply be values which changed between Laravel versions. You may ignore any ENV variables you do not need to customize.

arborrow commented 2 weeks ago

:warning: The BROADCAST_DRIVER, CACHE_DRIVER, and DATABASE_URL environment variables were renamed in Laravel 11 to BROADCAST_CONNECTION, CACHE_STORE, and DB_URL, respectively.

Shift automated this change for your committed files, but you should review any additional locations where your environment is configured and update to the new variable names.

arborrow commented 2 weeks ago

:warning: Laravel 11 automatically discovers policies scanning your application's Policies directory at or above the directory containing your models.

Shift detected policies registered with the policies property of your AuthServiceProvider. If any of these policies can not be automatically discovered, you may register them manually using Gate::policy() in your AppServiceProvider.

arborrow commented 2 weeks ago

:warning: Shift was unable to re-register your exception handler. You may review the documentation to do so manually, or register your original exception handler by adding the following binding to the register method of your AppServiceProvider:

$this->app->bind(\Illuminate\Contracts\Debug\ExceptionHandler::class, \App\Exceptions\Handler::class);
arborrow commented 2 weeks ago

:information_source: Shift updated your dependencies for Laravel 11. While many of the popular packages are reviewed, you may have to update additional packages in order for your application to be compatible with Laravel 11. Watch dealing with dependencies for tips on handling any Composer issues.

The following dependencies were updated by a major version and may have their own changes. You may check their changelog for any additional upgrade steps.

arborrow commented 2 weeks ago

:information_source: Starting with Laravel 10, PHP type hints were added within classes included in a Laravel application. In an effort to modernize your code, Shift automated this change where Laravel strictly specifies a type. If you prefer not to type hint your code you may revert this commit by running: git revert 842c8e1f

arborrow commented 2 weeks ago

:information_source: The base Controller class has been marked as abstract in Laravel 11, with its traits and inheritance removed. This is to prevent using this base controller directly and to use facades instead of the trait methods.

Shift detected your base controller did not have any public methods, so it was safe to mark as abstract. However, since you may be using trait methods within your controllers, Shift did not remove them. If you know you are not using any trait methods or want to refactor to facades, you may remove them manually.

arborrow commented 2 weeks ago

:warning: In Laravel 11, changing a column now requires you to include all the modifiers you want to keep on the column definition after it is changed. Any missing attributes will be dropped. This change may cause unexpected behavior if you were to run pending or old migrations.

Shift detected potential uses of the change method within your migrations. While you may go back and update these migrations, you may wish to simply squash your old migrations. This will not only avoid rework, but may also improve the performance of your test suite.

arborrow commented 2 weeks ago

:warning: Laravel 11 has removed its dependency on doctrine/dbal. Shift detected your project contains this dependency. If you are not using this package directly or were only using it for change migrations, you may remove it by running: composer remove doctrine/dbal

arborrow commented 2 weeks ago

:warning: Many first-party Laravel packages no longer load their migrations automatically. Instead, you may need to publish their migrations to your application if you have not already done so. Shift detected you are using Cashier, and Sanctum. You may run the following command to publish their migrations:

php artisan vendor:publish --tag=cashier-migrations
php artisan vendor:publish --tag=sanctum-migrations
arborrow commented 2 weeks ago

:information_source: Laravel 11 now updates the timestamp when publishing vendor migrations. This may cause problems in existing applications when these migrations were previously published and ran with their default timestamp.

To preserve the original behavior, Shift disabled this feature in your database.php configuration file. If you do not have any vendor migrations or have squashed all of your existing migrations, you may re-enable the update_date_on_publish option. If this is the only customization within database.php, you may remove this configuration file.

arborrow commented 2 weeks ago

:warning: Previously, Laravel would append a colon (:) to any cache key prefix for DynamoDB, Memcache, or Redis. Laravel 11 no longer appends a colon to your cache key prefix. If you are using one of these stores, you should append a colon to your prefix to avoid invalidating your cache.

arborrow commented 2 weeks ago

:warning: Many of the default drivers changed in Laravel 11. For example, the default database driver is sqlite and the default cache store is database. If you experience errors setting up your environment, be sure you have properly set your ENV variables for these drivers. If you wish to adopt the new defaults, you may follow the documentation to set them up for your application.

arborrow commented 2 weeks ago

:information_source: All of the underlying Symfony components used by Laravel have been upgraded to Symfony 7.0. Shift detected references to Symfony classes within your application. These are most likely type hints and can safely be ignored. If you are using Symfony classes directly or experience issues relating to Symfony, you should review the Symfony change log for any additional changes.

arborrow commented 2 weeks ago

:warning: Laravel 11 has a nesbot/carbon dependency of ^2.72|^3.0. Carbon 3.0 contains some breaking changes. Most notably to the diffIn* methods and the removal of the setUtf8, formatLocalized, setWeekStartsAt, setWeekEndsAt methods. Shift detected you are using these methods within your application. While you may try to downgrade to Carbon 2, Shift recommends you review the Carbon migration notes and complete the upgrade to Carbon 3.0.

arborrow commented 2 weeks ago

:warning: Laravel 11 requires PHP 8.2 or higher. You should verify the PHP version in your environments to ensure it meets this new requirement.

arborrow commented 2 weeks ago

:warning: Laravel 11 now includes a database driver for MariaDB. Previously the MySQL driver offered parity with MariaDB. However, with MariaDB 10.1, there are more database specific features available. If you are using MariaDB, you may want to evaluate this new mariadb driver after completing your upgrade to Laravel 11.

arborrow commented 2 weeks ago

:tada: Congratulations, you're now running the latest version of Laravel!

Next, you may optionally run the following Shifts to ensure your application is fully upgraded, adopts the latest Laravel conventions, and easier to maintain in the future:

You may also use the Shift Workbench to automate common tasks for maintaining your Laravel application.