Skip to content

Add upgrade tool documentation to migration guides #8149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markstory merged 1 commit into from
Jan 3, 2026
Merged

Add upgrade tool documentation to migration guides #8149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions en/appendices/5-1-migration-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ The 5.1.0 release is a backwards compatible with 5.0. It adds new functionality
and introduces new deprecations. Any functionality deprecated in 5.x will be
removed in 6.0.0.

Upgrade Tool
============

The :doc:`upgrade tool </appendices/migration-guides>` provides rector rules for
automating some of the migration work. Run rector before updating your
``composer.json`` dependencies::

bin/cake upgrade rector --rules cakephp51 <path/to/app/src>

Behavior Changes
================

Expand Down
9 changes: 9 additions & 0 deletions en/appendices/5-2-migration-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ The 5.2.0 release is a backwards compatible with 5.0. It adds new functionality
and introduces new deprecations. Any functionality deprecated in 5.x will be
removed in 6.0.0.

Upgrade Tool
============

The :doc:`upgrade tool </appendices/migration-guides>` provides rector rules for
automating some of the migration work. Run rector before updating your
``composer.json`` dependencies::

bin/cake upgrade rector --rules cakephp52 <path/to/app/src>

Behavior Changes
================

Expand Down
9 changes: 9 additions & 0 deletions en/appendices/5-3-migration-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ The 5.3.0 release is a backwards compatible with 5.0. It adds new functionality
and introduces new deprecations. Any functionality deprecated in 5.x will be
removed in 6.0.0.

Upgrade Tool
============

The :doc:`upgrade tool </appendices/migration-guides>` provides rector rules for
automating some of the migration work. Run rector before updating your
``composer.json`` dependencies::

bin/cake upgrade rector --rules cakephp53 <path/to/app/src>

Upgrade to PHP 8.2
==================

Expand Down
22 changes: 22 additions & 0 deletions en/appendices/migration-guides.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ Migration Guides
Migration guides contain information regarding the new features introduced in
each version and the migration path between 5.x minor releases.

Upgrade Tool
============

CakePHP provides an `upgrade tool <https://github.com/cakephp/upgrade>`__ that
automates many code changes using `Rector <https://getrector.com/>`__. The tool
has rulesets for each minor version to help automate tedious code changes like
method renames and signature updates.

To use the upgrade tool::

# Install the upgrade tool
git clone https://github.com/cakephp/upgrade
cd upgrade
git checkout 5.x
composer install --no-dev

# Run rector with the desired ruleset
bin/cake upgrade rector --rules cakephp51 <path/to/app/src>

Run rector before updating your ``composer.json`` dependencies
to ensure the tool can resolve class names correctly.

.. toctree::
:maxdepth: 1

Expand Down
Loading