Upgrade Commerce | Archived 2.3 Magento Developer Guide

You can upgrade your Magento application from the command line if you installed the software by:

Downloading the metapackage using composer create-project.
Installing the compressed archive.

Do not use this method to upgrade if you cloned the Magento 2 GitHub repository. Instead, see Update Magento for upgrade instructions.

Before you begin

Complete the following prerequisites to prepare your environment before starting the upgrade process:

Determine whether your current catalog search engine is supported-Avoid significant upgrade errors by ensuring your search engine complies with 2.3 requirements. See Verify Elasticsearch is installed for more details.
Complete the Update and upgrade checklist—To avoid possible errors during installation or upgrading, complete the Update and upgrade checklist.
Set the pub/ directory root—See Modify docroot to improve security for more details.
Check PHP and environment settings—Verify that your PHP and other environment settings are compatible with the system requirements.
Switch to maintenance mode—To prevent access to your store while it’s being upgraded, switch your store to maintenance mode:
```
1
 bin/magento maintenance:enable
```
See Enable or disable maintenance mode for additional options.

Optionally, you can create a custom maintenance mode page.
Check the status of cron jobs—To prevent various unexpected problems during the upgrade, wait for all active running Magento cron jobs to finish or stop them.
Install the Composer update plugin—The magento/composer-root-update-plugin Composer plugin resolves changes that need to be made to the root project composer.json file before updating to a new Magento product requirement.

The plugin partially automates the manual upgrade by identifying and helping you resolve dependency conflicts instead of requiring you to identify and fix them manually.

To install the plugin when using PHP 7.3 or higher:
```
1
composer require magento/composer-root-update-plugin ~2.0 --no-update
```
To install the plugin when using PHP 7.2 or lower:

This version of the plugin is not compatible with Composer 2.1.6 or higher
```
1
composer require magento/composer-root-update-plugin ~1.1 --no-update
```
Update the dependencies:
```
1
composer update
```

Manage packages

See the examples at the end of this section for help specifying different release levels. For example, minor release, quality patch, and security patch. Adobe Commerce customers can access patches two weeks before the General Availability (GA) date. Pre-release packages are available through Composer only. You cannot find them on the Magento Portal or GitHub until GA. If you cannot find these packages in Composer, contact Adobe Commerce Support.

Backup the composer.json file.

cp composer.json composer.json.bak

Add or remove specific packages based on your needs. For example, if you are upgrading from Magento Open Source to Adobe Commerce, remove the Magento Open Source package.

composer remove magento/product-community-edition --no-update

Choose one of the following composer commands based on the PHP version, and run the command to upgrade your instance.

For 7.3 or higher:

composer require-commerce magento/<product> <version> --no-update [--interactive-root-conflicts] [--force-root-updates] [--help]

For PHP 7.2 or lower:

composer require magento/<product> <version> --no-update [--interactive-magento-conflicts] [--use-default-magento-values] [--help]

where:

<product> - (Required) The package to upgrade. For on-premises installations, you must specify either product-community-edition or product-enterprise-edition.

<version> - (Required) The version of Magento Open Source or Magento Open Source you are upgrading to. For example, 2.3.7.

--no-update - (Required) Disables the automatic update of the dependencies.

--interactive-root-conflicts or interactive-magento-conflicts - (Optional) Allows you to interactively view and update any out-of-date values from previous versions.

--force-root-updates or --use-default-magento-values - (Optional) Overrides all conflicting custom values with the expected Magento values.

--help - (Optional) Provides usage details about the plugin.

If neither --interactive-root-conflicts nor --force-root-updates (or their PHP 7.2 equivalents) are specified, the command keeps the existing values that are in conflict and displays a warning message.

To learn more about the plugin, refer to one of the following Plugin Usage README files:

Examples:

Magento Open Source:

composer require-commerce magento/product-community-edition 2.3.7 --no-update

Adobe Commerce:

composer require-commerce magento/product-enterprise-edition 2.3.7 --no-update

To see the full list of available 2.3 versions:

Magento Open Source:

composer show magento/product-community-edition 2.3.* --all | grep -m 1 versions

Adobe Commerce:

composer show magento/product-enterprise-edition 2.3.* --all | grep -m 1 versions

Update the dependencies.
```
1
composer update
```

Example - Minor release

Minor releases contain new features, quality fixes, and security fixes. Use Composer to specify a minor release. For example, to specify the Adobe Commerce 2.3.7 metapackage:

composer require-commerce magento/product-community-edition 2.3.7 --no-update

Example - Quality patch

Quality patches primarily contain functional and security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to specify the Adobe Commerce 2.3.7 metapackage:

composer require-commerce magento/product-community-edition 2.3.7 --no-update

Example - Security patch

Security patches contain security fixes only. They are designed to make the upgrade process faster and easier.

Security patches use the Composer naming convention 2.3.x-px. Use Composer to specify a patch. For example, to download the Magento Open Source 2.3.6-p1 metapackage:

composer require-commerce magento/product-community-edition 2.3.6-p1 --no-update

Update metadata

Update the "name", "version", and "description" fields in the composer.json file as needed.

Updating the metadata in composer.json file is entirely superficial, not functional.
Apply updates.
```
1
composer update
```

Clear the var/ and generated/ subdirectories:

rm -rf var/cache/*

rm -rf var/page_cache/*

rm -rf generated/code/*

If you use a cache storage other than the filesystem, such as Redis or Memcached, you must manually clear the cache there too.

Update the database schema and data.

bin/magento setup:upgrade

Disable maintenance mode.

bin/magento maintenance:disable

(Optional) Restart Varnish.

If you use Varnish for page caching, restart it:

service varnish restart

Check your work

Open your storefront URL in a web browser to check whether the upgrade was successful. If your upgrade was unsuccessful, your storefront will not load properly.

If the application fails with a We're sorry, an error has occurred while generating this email. error:

Reset file system ownership and permissions as a user with root privileges.
Clear the following directories:
- var/cache/
- var/page_cache/
- generated/code/
Check your storefront in your web browser again.