This page explains how to update between minor or patch versions of eZ Platform.

In the instructions below, replace <version> with the version of eZ Platform you are updating to (for example: v1.2.0).

If you are testing a release candidate, use the latest rc tag (for example: v1.2.1-rc1).

Update procedure

Existing projects can easily be updated using Composer. From the project's root, create a new branch from the project's master, or from the branch you're upgrading on:

git checkout -b <branch_name>

If it's not there, add ezsystems/ezplatform as an upstream remote:

git remote add ezplatform http://github.com/ezsystems/ezplatform.git

Then pull the tag into your branch:

git pull ezplatform <version>

You will get conflicts, and it is perfectly normal. The most common ones will be on composer.json and composer.lock.
The latter can be ignored, as it will be regenerated when we execute composer update later. The easiest is to checkout the version from the tag, and add it to the changes:

git checkout --theirs composer.lock && git add composer.lock

You may also run git remove composer.lock if you do not keep a copy of it in the branch.

Merging composer.json

Manual merging

Conflicts in composer.json need to be fixed manually. If you're not familiar with the diff output, you may checkout the tag's version, and inspect the changes. It should be readable for most:

git checkout --theirs composer.json && git diff composer.json

You should see what was changed, as compared to your own version, in the diff output. The ezplatform update changes the requirements for all of the ezsystems/ packages. Those changes should be left untouched. All of the other changes will be removals of what you added for your own project. Use git checkout -p to selectively cancel those changes:

git checkout -p composer.json

Answer no (do not discard) to the requirement changes of ezsystems dependencies. Answer yes (discard) to removals of your changes.

Once you are done, inspect the file, either using an editor or by running git diff composer.json. You may also test the file's sanity with composer validate, and test the dependencies by running composer update --dry-run. (will output what it would do to dependencies, without applying the changes.

Once finished, run git add composer.json.

Fixing other conflicts (if any)

Depending on the local changes you have done, you may get other conflicts: configuration files, kernel... 

There shouldn't be many, and you should be able to figure out which value is the right one for all of them:

• Edit the file, and identify the conflicting changes. If a setting you have modified has also been changed by us, you should be able to figure out which value is the right one.
• Run git add conflicting-file to add the changes

Updating composer.lock

At this point, you should have a composer.json file with the correct requirements. Run composer update to update the dependencies. 

composer update --with-dependencies ezsystems/ezpublish-kernel ezsystems/platform-ui-bundle ezsystems/behatbundle

mysql -u<username> -p<password> <database_name> < vendor/ezsystems/ezpublish-kernel/data/update/mysql/dbupdate-6.1.0-to-6.2.0.sql

Dump assets

The web assets must be dumped again for the prod environment:

php app/console assetic:dump --env=prod web

Commit, test and merge

Once all the conflicts have been resolved, and composer.lock updated, the merge can be committed. Note that you may or may not keep composer.lock, depending on your version management workflow. If you do not wish to keep it, run git reset HEAD <file> to remove it from the changes. Run git commit, and adapt the message if necessary. You can now test the project, run integration tests... once the upgrade has been approved, go back to master, and merge your new update branch:

git checkout master
git merge <branch_name>