Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 3.21 KB

UPGRADE.md

File metadata and controls

55 lines (39 loc) · 3.21 KB

Upgrade Guide

Upgrading to 9.x from 8.x

9.x drops support for Laravel v6 and v7 to support PHPUnit v10. There are no other breaking changes. If you're on Laravel v8+, you may simply re-run composer require diglactic/laravel-breadcrumbs.

Upgrading to 8.x from 7.x

8.x introduces a single breaking change over 7.x by passing request parameters injected by middleware into Breadcrumbs closures. If you're not mutating request parameters in your middleware, you can safely upgrade without any code changes. See #52 for more details.

Upgrading to 7.x from 6.x

7.x introduces some breaking changes from 6.x, mainly, housekeeping items.

If you've already upgraded your code when switching to 5.x, this new version should be relatively seamless.

Upgrading to 6.x from 5.x

These upgrade notes serve to bring you off of the latest version of DaveJamesMiller\Breadcrumbs to this repository. Note that this library requires at least Laravel 6.

Begin by swapping libraries via Composer:

composer remove davejamesmiller/laravel-breadcrumbs
composer require diglactic/laravel-breadcrumbs

Next, you'll need to update the following references. While we've made most classes backwards-compatible and your project should work right away, it's a good idea to update these sooner than later as they'll be removed in a future version.

davejamesmiller/laravel-breadcrumbs diglactic/laravel-breadcrumbs
DaveJamesMiller\Breadcrumbs\BreadcrumbsManager Diglactic\Breadcrumbs\Manager
DaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator Diglactic\Breadcrumbs\Generator
DaveJamesMiller\Breadcrumbs\BreadcrumbsServiceProvider Diglactic\Breadcrumbs\ServiceProvider
DaveJamesMiller\Breadcrumbs\Facades\Breadcrumbs Diglactic\Breadcrumbs\Breadcrumbs

Once you're done, double-check your work by searching for DaveJamesMiller\Breadcrumbs within your application and making any necessary replacements. Note class name changes, like BreadcrumbsManager to Manager. If you've never gone off script, you should be all set.

If you ran into trouble following this upgrade guide, please file an issue. Happy coding!