Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 4.36 KB

ece-tools-upgrade-project.md

File metadata and controls

115 lines (82 loc) · 4.36 KB
Raw
group title functional_areas redirect_to status
cloud-guide
Upgrade project to use ece-tools
Cloud
Upgrade
migrated

Adobe deprecated the magento/magento-cloud-configuration and magento/ece-patches packages in favor of the {{site.data.var.ct}} package, which simplifies many cloud processes. If you use an older {{site.data.var.ece}} project that does not contain the {{site.data.var.ct}} package, then you must perform a one-time, manual upgrade process to your project.

{:.bs-callout-warning} If your project contains the {{site.data.var.ct}} package, you can skip the following upgrade. To verify, retrieve the Commerce version using the php vendor/bin/ece-tools -V command at your local project root directory.

This project upgrade process requires you to update the magento/magento-cloud-metapackage version constraint in the composer.json file at the root directory. This constraint enables updates for {{site.data.var.ece}} metapackages—including removing deprecated packages—without upgrading your current {{site.data.var.ee}} version.

{% include cloud/note-upgrade.md %}

Remove deprecated packages

Before performing an upgrade to use the {{site.data.var.ct}} package, check the composer.lock file for the following deprecated packages:

  • magento/magento-cloud-configuration
  • magento/ece-patches

Update the metapackage {#metapackage}

Each {{site.data.var.ee}} version requires a different constraint based on the following:

>=current_version <next_version
  • For current_version, specify the {{site.data.var.ee}} version to install.
  • For next_version, specify the next patch version after the value specified in current_version.

If you want to install {{site.data.var.ee}} 2.3.5-p2, set current_version to 2.3.5 and the next_version to 2.3.6. The constraint ">=2.3.5 <2.3.6" installs the latest available package for 2.3.5.

You can always find the latest metapackage constraint in the magento-cloud template.

The following example places a constraint for the {{site.data.var.ece}} metapackage to any version greater than or equal to the current version 2.3.4 and lower than next version 2.3.5:

"require": {
    "magento/magento-cloud-metapackage": ">=2.3.4 <2.3.5"
},

Upgrade the project

To upgrade your project to use the {{site.data.var.ct}} package, you must update the metapackage, update the .magento.app.yaml hooks properties, and perform a Composer update.

{:.procedure} To upgrade project to use ece-tools:

  1. Update the magento/magento-cloud-metapackage version constraint in the composer.json file.

    composer require "magento/magento-cloud-metapackage":">=2.3.4 <2.3.5" --no-update

  2. Update the metapackage.

    composer update magento/magento-cloud-metapackage

  3. Modify the hook commands in the magento.app.yaml file.

    hooks:
    # We run build hooks before your application has been packaged.
    build: |
        set -e
        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

  4. Check for and remove the deprecated packages. The deprecated packages can prevent a successful upgrade.

    composer remove magento/magento-cloud-configuration
    composer remove magento/ece-patches

  5. It may be necessary to update the {{site.data.var.ct}} package.

    composer update magento/ece-tools

  6. Add and commit the code changes. In this example, the following files were updated:

    .magento.app.yaml
composer.json
composer.lock

    {:.no-copy}

  7. Push your code changes to the remote server and merge this branch with the integration branch.

    git push origin <branch-name>