menu

Upgrade Instructions 4.2 → 4.3

Support the documentation

This documentation was written by volunteers. Please help support our effort:

Help us improve the documentation

Upgrade Instructions 4.2 → 4.3

By using composer, you can update an existing installation to a specific version, without having to create a new project.

For further information on what changed please take a look at the release notes (Neos, Flow) and the changelogs (Neos, Flow)

Instructions

Before doing substantial changes, make sure you create a backup of the database and files!

cd /installation-root/
# Update the core package dependencies
composer require --no-update "neos/neos:~4.3.0"
composer require --no-update "neos/nodetypes:~4.3.0"

# Update optional package dependencies (if installed)
composer require --no-update "neos/demo:~4.3.0"
composer require --no-update "neos/site-kickstarter:~4.3.0"

If you have development packages in your composer manifest, update them to match as well:

# Update development packages (if installed)
composer require --no-update --dev "neos/buildessentials:5.3.x-dev"

Breaking changes

This is a minor release so no breaking changes to public APIs were introduced. 
However the following changes may hit you if you used private apis in your project. 

Neos
  1. New NodeInterface and TraversableNodeInterface:
    The new interfaces NodeInterface and TraversableNodeInterface are introduced to replace the classic NodeInterface which is now deprecated. This change is necessary to ensure a smooth upgrade later on to the Event Sourced CR so people working with NodeInterface in their custom code can already start using TraversableNodeInterface today.
  2. Altered implementations of Fusion Menu:
    The old MenuImplementation classes (which were not part of the public API) are removed and new implementations for MenuItems were added. White the Fusion-api is the same, if you extended the implementation classes, you will have to adapt your code.
Flow

Introduce ActionResponse in preparation for clean PSR-7
This is the continuation to a clear separation between MVC and HTTP stacks. 
The introduced ActionResponse offers a very limited interface to work with on the MVC level.

Neos & Flow 

We upgraded our internal testing suite to latest neos/behat version.
In case you have behat tests in place, but did not set your own behat version in the dev dependencies consider it doing now.

Neos Demo 5.0

In case you are using Neos.Demo in your project as site-package or dependency (which we strongly advise against) you will have to check your code and run the included node-migrations since this is a major update with breaking changes. See the release notes for further information: https://github.com/neos/Neos.Demo/releases/tag/5.0.0

Neos SEO Package 3.0

New installations come with the newest major release for the Neos SEO package. If you want to upgrade (which you have to do manually), be aware of the breaking changes within this major release. For details see:
https://github.com/neos/neos-seo/releases/tag/3.0.0

Finish the update

# Update the packages
composer update

# Flush the caches
./flow flow:cache:flush --force
./flow flow:session:destroyAll

# Run code migrations (as needed for any packages that need to be migrated)
./flow flow:core:migrate <Vendor.PackageName>

# If not already on 4.0 or 4.1, set database charset and update to the new default given character set and collation
./flow database:setcharset

# Run database migrations
./flow doctrine:migrate

# Publish resources
./flow resource:publish

Troubleshooting

If you run into trouble with Neos content or resources, the following may help: 

# If you get error messages when running Flow CLI commands:
rm -rf Data/Temporary

# If you experience issues with pages not working, try 
./flow node:repair

# If you experience issues with resources, thumbnail or assets, try
./flow resource:clean
./flow media:clearthumbnails