Upgrade Commerce version

You can upgrade the Adobe Commerce code base to a newer version. Before upgrading your project, review the System requirements in the Installation guide for the latest software version requirements.

Depending on your project configuration, your upgrade tasks may include the following:

  • Update services for compatibility with new Adobe Commerce versions. See Change service version.
  • Convert an older configuration management file.
  • Update the .magento.app.yaml file with new settings for hooks and environment variables.
  • Upgrade third-party extensions to the latest supported version.
  • Update the .gitignore file.
TIP

Before beginning an upgrade or a patching process, create an active branch from the Integration environment and check out the new branch to your local workstation. Dedicating a branch to the upgrade or the patch process helps to avoid interference with your work in progress.

TIP

For Pro projects, you must Submit an Adobe Commerce Support ticket to install or update services in Staging and Production environments. Indicate the service changes needed and include your updated .magento.app.yaml and services.yaml files and PHP version in the ticket. It can take up to 48 hours for the Cloud infrastructure team to update your project.

Upgrade from older versions

If you are beginning an upgrade from a Commerce version older than 2.1, some restrictions in the Adobe Commerce code base can affect your ability to update to a specific ECE-Tools release or to upgrade to the next supported Commerce version. Use the following table to determine the best path:

Current Version Upgrade Path
2.1.3 and earlier Upgrade Adobe Commerce to version 2.1.4 or later before you continue. Then perform a one-time upgrade to install ECE-Tools.
2.1.4 – 2.1.14 Update ECE-Tools package.
See release notes for 2002.0.9 and later 2002.0.x releases.
2.1.15 – 2.1.16 Update ECE-Tools package.
See release notes for2002.0.9 and later.
2.2.x and later Update ECE-Tools package.
See release notes for2002.0.8 and later.
NOTE

If you use a version of Adobe Commerce on cloud infrastructure that does not contain the ece-tools package, then you must perform a one-time upgrade to your cloud project to remove deprecated packages. If you currently use the ece-tools package and you need to update it, see Update the ECE-Tools package.

Configuration management

Older versions of Adobe Commerce, such as 2.1.4 or later to 2.2.x or later, used a config.local.php file for Configuration Management. Adobe Commerce version 2.2.0 and later use the config.php file, which works exactly like the config.local.php file, but it has different configuration settings that include a list of your enabled modules and additional configuration options.

When upgrading from an older version, you must migrate the config.local.php file to use the newer config.php file. Use the following steps to back up your configuration file and create one.

To create a temporary config.php file:

  1. Create a copy of config.local.php file and name it config.php.

  2. Add this file to the app/etc folder of your project.

  3. Add and commit the file to your branch.

  4. Push the file to your integration branch.

  5. Continue with the upgrade process.

WARNING

After upgrading, you can remove the config.php file and generate a new, complete file. You can only delete this file to replace it this one time. After generating a new, complete config.php file, you cannot delete the file to generate a new one. See Configuration Management and Pipeline Deployment.

Verify Zend Framework composer dependencies

When upgrading to 2.3.x or later from 2.2.x, verify that the Zend Framework dependencies have been added to the autoload property of the composer.json file to support Laminas. This plugin supports new requirements for the Zend Framework, which has migrated to the Laminas project. See Migration of Zend Framework to the Laminas Project on the Magento DevBlog.

To check the auto-load:psr-4 configuration:

  1. On your local workstation, change to your project directory.

  2. Check out your integration branch.

  3. Open the composer.json file in a text editor.

  4. Check the autoload:psr-4 section for the Zend plugin manager implementation for controllers dependency.

     "autoload": {
        "psr-4": {
           "Magento\\Framework\\": "lib/internal/Magento/Framework/",
           "Magento\\Setup\\": "setup/src/Magento/Setup/",
           "Magento\\": "app/code/Magento/",
           "Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"
        },
    }
    
  5. If the Zend dependency is missing, update the composer.json file:

    • Add the following line to the autoload:psr-4 section.

      "Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"
      
    • Update the project dependencies.

      composer update
      
    • Add, commit, and push code changes.

      git add -A
      
      git commit -m "Add Zend plugin manager implementation for controllers dependency for Laminas support"
      
      git push origin <branch-name>
      
    • Merge changes to the Staging environment, and then to Production.

Configuration files

Before upgrading the application, you must update your project configuration files to account for changes to the default configuration settings for Adobe Commerce on cloud infrastructure or the application. The latest defaults can be found in the magento-cloud GitHub repository.

.magento.app.yaml

Always review the values contained in the .magento.app.yaml file for your installed version, because it controls the way your application builds and deploys to the cloud infrastructure. The following example is for version 2.4.4 and uses Composer 2.2.4. The build: flavor: property is not used for Composer 2.x; see Installing and using Composer 2.

To update the .magento.app.yaml file:

  1. On your local workstation, change to your project directory.

  2. Open and edit the magento.app.yaml file.

  3. Update the PHP options.

    type: php:8.1
    
    build:
        flavor: none
    dependencies:
        php:
            composer/composer: '2.2.4'
    
  4. Modify the hooks property build and deploy commands.

    hooks:
        # We run build hooks before your application has been packaged.
        build: |
            set -e
            composer install
            php ./vendor/bin/ece-tools run scenario/build/generate.xml
            php ./vendor/bin/ece-tools run scenario/build/transfer.xml
        # We run deploy hook after your application has been deployed and started.
        deploy: |
            php ./vendor/bin/ece-tools run scenario/deploy.xml
        # We run post deploy hook to clean and warm the cache. Available with ECE-Tools 2002.0.10.
        post_deploy: |
            php ./vendor/bin/ece-tools run scenario/post-deploy.xml
    
  5. Add the following environment variables to the end of the file.

    For Adobe Commerce 2.2.x through 2.3.x–

    variables:
        env:
            CONFIG__DEFAULT__PAYPAL_ONBOARDING__MIDDLEMAN_DOMAIN: 'payment-broker.magento.com'
            CONFIG__STORES__DEFAULT__PAYMENT__BRAINTREE__CHANNEL: 'Magento_Enterprise_Cloud_BT'
            CONFIG__STORES__DEFAULT__PAYPAL__NOTATION_CODE: 'Magento_Enterprise_Cloud'
    

    For Adobe Commerce 2.4.x–

    variables:
        env:
            CONFIG__DEFAULT__PAYPAL_ONBOARDING__MIDDLEMAN_DOMAIN: 'payment-broker.magento.com'
            CONFIG__STORES__DEFAULT__PAYPAL__NOTATION_CODE: 'Magento_Enterprise_Cloud'
    
  6. Save the file. Do not commit or push changes to the remote environment yet.

  7. Continue with the upgrade process.

composer.json

Before upgrading, always check that the dependencies in the composer.json file are compatible with the Adobe Commerce version.

To update the composer.json file for Adobe Commerce version 2.4.4:

  1. Add the following allow-plugins to the config section:

    
    "config": {
       "allow-plugins": {
          "dealerdirect/phpcodesniffer-composer-installer": true,
          "laminas/laminas-dependency-plugin": true,
          "magento/*": true
       }
    },
    
  2. Add the following plugin to the require section:

    "require": {
        "magento/composer-root-update-plugin": "^2.0.2"
    },
    
  3. Add the following component to the extra:component_paths section:

    "extra": {
       "component_paths": {
          "tinymce/tinymce": "lib/web/tiny_mce_5"
       },
    },
    
  4. Save the file. Do not commit or push changes to your branch yet.

  5. Continue with the upgrade process.

Project backup

We recommend creating a backup of your project before an upgrade. Use the following steps to back up your Integration, Staging, and Production environments.

To back up your Integration environment database and code:

  1. Create a local backup of the remote database.

    magento-cloud db:dump
    
    NOTE

    The magento-cloud db:dump command runs the mysqldump command with the --single-transaction flag, which allows you to back up your database without locking the tables.

  2. Back up code and media.

    php bin/magento setup:backup --code [--media]
    

    Optionally, you can omit [--media] if you have a large number of static files that are already in source control.

To back up your Staging or Production environment database before deploying:

  1. Use SSH to log in to the remote environment.

  2. Create a database dump. To choose a target directory for the DB dump, use the --dump-directory option.

    vendor/bin/ece-tools db-dump
    

    The dump operation creates a dump-<timestamp>.sql.gz archive file in your remote project directory. See Snapshot and backup management.

Application upgrade

Review the service versions information for the latest software version requirements before upgrading your application.

To upgrade the application version:

  1. On your local workstation, change to your project directory.

  2. Set the upgrade version using the version constraint syntax.

    composer require "magento/magento-cloud-metapackage":">=CURRENT_VERSION <NEXT_VERSION" --no-update
    
    NOTE

    You must use the version constraint syntax to successfully update the ECE-Tools package. You can find the version constraint in the composer.json file for the version of the application template you are using for the upgrade.

  3. Update the project.

    composer update
    
  4. Add, commit, and push code changes.

    git add -A
    
    git commit -m "Upgrade"
    
    git push origin <branch-name>
    

    git add -A is required to add all changed files to source control because of the way Composer marshals base packages. Both composer install and composer update marshal files from the base package (magento/magento2-base and magento/magento2-ee-base) into the package root.

    The files that Composer marshals belong to the new version of Adobe Commerce, to overwrite the outdated version of those same files. Currently, marshaling is disabled in Adobe Commerce, so you must add the marshaled files to source control.

  5. Wait for deployment to complete.

  6. Verify the upgrade in your Integration, Staging, or Production environment by using SSH to log in and check the version.

    php bin/magento --version
    

Create a config.php file

As mentioned in Configuration management, after upgrading, you must create an updated config.php file. Complete any additional configuration changes through the Admin in your Integration environment.

To create a system-specific configuration file:

  1. From the terminal, use an SSH command to generate the /app/etc/config.php file for the environment.

    ssh <SSH-URL> "<Command>"
    

    For example for Pro, to run the scd-dump on the integration branch:

    ssh <project-id-integration>@ssh.us.magentosite.cloud "php vendor/bin/ece-tools config:dump"
    
  2. Transfer the config.php file to your local workstations using rsync or scp. You can only add this file to the branch locally.

    rsync <SSH-URL>:app/etc/config.php ./app/etc/config.php
    
  3. Add, commit, and push code changes.

    git add app/etc/config.php && git commit -m "Add system-specific configuration" && git push origin master
    

    This generates an updated /app/etc/config.php file with a module list and configuration settings.

WARNING

For an upgrade, you delete the config.php file. Once this file is added to your code, you should not delete it. If you must remove or edit settings, edit the file manually.

Upgrade extensions

Review your third-party extension and module pages in Marketplace or other company sites and verify support for Adobe Commerce and Adobe Commerce on cloud infrastructure. If you must upgrade any third-party extensions and modules, Adobe recommends working in a new integration branch with your extensions disabled.

To verify and upgrade your extensions:

  1. Create a branch on your local workstation.

  2. Disable your extensions as needed.

  3. When available, download extension upgrades.

  4. Install the upgrade as documented by the third-party documentation.

  5. Enable and test the extension.

  6. Add, commit, and push the code changes to the remote.

  7. Push to and test in your Integration environment.

  8. Push to the Staging environment to test in a pre-production environment.

Adobe strongly recommends upgrading your Production environment before including the upgraded extensions in your site launch process.

NOTE

When you upgrade your application version, the upgrade process updates to the latest version of the Fastly CDN module automatically.

Troubleshoot upgrade

If the upgrade failed, you receive an error message in the browser indicating that you cannot access your storefront or the Admin panel:

There has been an error processing your request
Exception printing is disabled by default for security reasons.
  Error log record number: <error-number>

To resolve the error:

  1. On your local workstation, change to your project directory.

  2. Use SSH to log in to the remote environment.

    magento-cloud ssh
    
  3. Open the ./app/var/report/<error number> file.

  4. Examine the logs and determine the source of the issue.

  5. Add, commit, and push code changes.

    git add -A && git commit -m "Fixed deployment failure" && git push origin <branch-name>
    

On this page