dereuromark/upgrade-cakephp

CakePHP upgrade tool

CakePHP Upgrade tool

, _(*1)

Upgrade tool as standalone application for CakePHP meant to facilitate migrating - ~~from CakePHP 2.x to 3.x.~~ [EOL] - ~~supports the minor upgrades in 3.x - up until currently 3.8+.~~ [EOL] - ~~supports basic stuff for 4.x~~ [See cake4 branch] - supports basic stuff for 5.x + extension development possible, _(*2)

Warning This tool is still under development and doesn't handle all aspects of migrating., _(*3)

CakePHP 5

The brand new upgrade command of this tool provides a configurable approach. Define sets/levels and run it over your app or plugin:, _(*4)

bin/cake upgrade files /path/to/repo -v -d

Keep verbose and dry-run for checking if it works as expected, then apply your changes for real., _(*5)

This tool works best in combination with the official upgrade tool and its rector based approaches. - dereuromark/upgrade handles basic cases and non-PHP files - cakephp/upgrade handles PHP class files via rector (requires valid PHP files), _(*6)

If rector fails or cannot handle your app, you can try to use this tool completely by defining more regex based rules for example., _(*7)

You can check active vs available tasks using --help together with -v. It will list all available ones, active ones are in green., _(*8)

For docs on this check here., _(*9)

Installation

This plugin is standalone. Do not try to mix this with your existing app. Instead, put it somewhere completely separate from it. Best to clone it (git clone ....)., _(*10)

After downloading/cloning the upgrade tool, you need to install dependencies with composer, _(*11)

composer install

Once dependencies are installed you can start using the upgrade shell., _(*12)

Note: If you want to get the latest master, you can run composer update at your own risk. It will download also all recent changes done. Alternatively, you can lock it down to a stable version and then update., _(*13)

IMPORTANT NOTICE

This tool is an add-on to original CakePHP upgrade tool and provides additional fixers: - Skeleton, _(*14)

The FileUpgrade tool also: - see src/Task/? (tons of custom fixes), _(*15)

Feel free to manually port those things back into the core one., _(*16)

Usage

Upgrade command

Important upgrade steps: - Skeleton upgrade (all skeleton files), _(*17)

bin/cake upgrade /home/mark/Sites/my-app

Upgrade files

See above bin/cake upgrade files docs., _(*18)

Upgrade legacy shell

See cake4 branch., _(*19)