Skip to content

Update the app to v3.3

Before you start this procedure, make sure you have completed the previous step, Updating code to v3.

5. Update to v3.3

Ibexa DXP v3.3 uses Symfony Flex. When updating from v3.2 to v3.3, you need to follow a special update procedure.

Note

Ibexa DXP v3.3 requires Composer 2.0.13 or higher.

First, create an update branch update-3.3 in git and commit your work.

If you have not done it before, add the relevant meta-repository as an upstream remote:

1
git remote add upstream http://github.com/ezsystems/ezplatform.git
1
git remote add upstream http://github.com/ezsystems/ezplatform-ee.git
1
git remote add upstream http://github.com/ezsystems/ezcommerce.git

Tip

It is good practice to make git commits after every step of the update procedure.

A. Merge project skeleton

Merge the current skeleton into your project:

1
2
3
git remote add content-skeleton https://github.com/ibexa/content-skeleton.git
git fetch content-skeleton --tags
git merge v3.3.24 --allow-unrelated-histories
1
2
3
git remote add experience-skeleton https://github.com/ibexa/experience-skeleton.git
git fetch experience-skeleton --tags
git merge v3.3.24 --allow-unrelated-histories
1
2
3
git remote add commerce-skeleton https://github.com/ibexa/commerce-skeleton.git
git fetch commerce-skeleton --tags
git merge v3.3.24 --allow-unrelated-histories

This introduces changes from the relevant website skeleton and results in conflicts.

Resolve the conflicts in the following way:

  • Make sure all automatically added ezsystems/* packages are removed. If you explicitly added any packages that are not part of the standard installation, retain them.
  • Review the rest of the packages. If your project requires a package, keep it.
  • If a package is only used as a dependency of an ezsystems package, remove it. You can check how the package is used with composer why <packageName>.
  • Keep the dependencies listed in the website skeleton.

Tip

You can also approach resolving conflicts differently: run git checkout --theirs composer.json to get a clean composer.json from the skeleton and then manually add any necessary changes from your project.

Caution

It is impossible to update an Enterprise edition (ezsystems/ezplatform-ee) to an Ibexa Content edition.

Also, make sure that composer.json has the following repositories entry:

1
2
3
4
"ibexa": {
    "type": "composer",
    "url": "https://updates.ibexa.co"
}

B. Update the app

Run composer update to update the dependencies:

1
composer update

Caution

Composer repository changes between 3.2 and 3.3 from updates.ez.no to updates.ibexa.co, therefore your credentials might be outdated.

username and password don't change. The repository they're used on changes.

See Composer authentication documentation to find the precedure that suits the way you're passing credentials.

In production, replace the old repository with the new one. But as a developer, you may need to go back to an earlier version, and should keep the old repository as well. For example, your auth.json may look like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "http-basic": {
        "updates.ibexa.co": {
            "username": "abcdefghijklmnopqrstuvwxyz012345",
            "password": "6789abcdefghijklmnopqrstuvwxyz01"
        },
        "updates.ez.no": {
            "username": "abcdefghijklmnopqrstuvwxyz012345",
            "password": "6789abcdefghijklmnopqrstuvwxyz01"
        }
    }
}

C. Configure the web server

Add the following rewrite rule to your web server configuration:

1
RewriteRule ^/build/ - [L]
1
rewrite "^/build/(.*)" "/build/$1" break;

Next steps

Now, proceed to the last step, updating to the latest v3.3 patch version.