[PaaS uniquement]{class="badge informative" title="S’applique uniquement aux projets Adobe Commerce on Cloud (infrastructure PaaS gérée par Adobe) et aux projets On-premise."}

Télécharger le Upgrade Compatibility Tool

Pour commencer à utiliser le Upgrade Compatibility Tool dans une interface de ligne de commande, téléchargez-le en exécutant la commande suivante :

composer create-project magento/upgrade-compatibility-tool uct --repository https://repo.magento.com

Vous devrez peut-être donner à l’outil des autorisations exécutables avec la commande chmod :

chmod +x ./uct/bin/uct

Upgrade Compatibility Tool dans une interface de ligne de commande

Le Upgrade Compatibility Tool est un outil qui compare une instance personnalisée Adobe Commerce à une version spécifique en analysant tous les modules qui y sont installés. Elle renvoie une liste des problèmes, erreurs et avertissements critiques qui doivent être résolus avant la mise à niveau vers la dernière version d’Adobe Commerce.

Voir ce tutoriel vidéo (06:02) pour en savoir plus sur le Upgrade Compatibility Tool.

Commandes disponibles pour le Upgrade Compatibility Tool dans une interface de ligne de commande :

Utiliser la commande upgrade:check

La commande upgrade:check recherche les modifications du code principal pour cette instance Adobe Commerce spécifique et toutes les modifications du code personnalisé installées dans celle-ci.

La commande upgrade:check est la commande principale pour exécuter l'outil :

bin/uct upgrade:check <dir>

Où <dir> valeur correspond au répertoire où se trouve votre instance Adobe Commerce.

Options disponibles pour la commande upgrade:check :

Le Upgrade Compatibility Tool vous permet d’exécuter la commande upgrade:check avec une option de --ignore-current-version-compatibility-issues. Utilisez cette option uniquement lorsque vous souhaitez obtenir les nouveaux problèmes introduits avec la mise à jour de votre version actuelle vers la version ciblée dans votre rapport Upgrade Compatibility Tool :

bin/uct upgrade:check --ignore-current-version-compatibility-issues <dir>

Ajout de l’option --coming-version

Vous pouvez comparer votre installation Adobe Commerce actuelle à n’importe quelle version d’Adobe Commerce >=2.3 à l’aide de l’option --coming-version .

Vous devez fournir la version sous forme de paramètre lors de l’exécution de la commande upgrade:check :

bin/uct upgrade:check <dir> -c 2.4.3

où -c, --coming-version[=COMING-VERSION] fait référence à la version ciblée d’Adobe Commerce.

Il existe certaines limitations lors de l’exécution du --coming-version :

Utiliser la commande dbschema:diff

Vous pouvez récupérer la différence entre le schéma de base de données de deux versions d’Adobe Commerce.

bin/uct dbschema:diff <current-version> <target-version>

Où les arguments sont les suivants :

Exemple d'exécution :

bin/uct dbschema:diff 2.4.3 2.4.3-p3

DB schema differences between versions 2.4.3 and 2.4.3-p3:

Table klarna_payments_quote constraint QUOTE_ID_KLARNA_PAYMENTS_QUOTE_QUOTE_ID_QUOTE_ENTITY_ID is present only in version 2.4.3-p3
Table klarna_payments_quote index KLARNA_PAYMENTS_QUOTE_SESSION_ID is present only in version 2.4.3-p3
Table customer_entity column session_cutoff is present only in version 2.4.3-p3
Table customer_visitor column session_id length value is different. 2.4.3: "64", 2.4.3-p3: "1"
Table customer_visitor column session_id comment value is different. 2.4.3: "Session ID", 2.4.3-p3: "Deprecated: Session ID value no longer used"
Table customer_visitor column created_at is present only in version 2.4.3-p3
Table oauth_consumer column secret length value is different. 2.4.3: "32", 2.4.3-p3: "128"
Table oauth_token column secret length value is different. 2.4.3: "32", 2.4.3-p3: "128"
Table admin_user_session column session_id nullable value is different. 2.4.3: "false", 2.4.3-p3: "true"
Table admin_user_session column session_id length value is different. 2.4.3: "128", 2.4.3-p3: "1"
Table admin_user_session column session_id comment value is different. 2.4.3: "Session ID value", 2.4.3-p3: "Deprecated: Session ID value no longer used"

Total detected differences between version 2.4.3 and 2.4.3-p3: 11

Utiliser la commande core:code:changes

Vous pouvez comparer votre installation Adobe Commerce actuelle pour vérifier si le code de base d’Adobe Commerce a été modifié afin d’implémenter une personnalisation. Cette commande affiche uniquement une liste des modifications principales :

bin/uct core:code:changes <dir> <vanilla dir>

Où les arguments sont les suivants :

Options disponibles pour la commande core:code:changes :

Installation Vanilla

Une installation vanilla est une installation propre d’une balise ou d’une branche de version spécifiée pour une version spécifique.

La commande bin/uct core:code:changes vérifie s’il existe une instance classique dans votre système. Si c’est la première fois que vous utilisez une installation classique, une question interactive en ligne de commande vous invite à télécharger le projet classique à partir du référentiel Adobe Commerce (https://repo.magento.com/).

Vous pouvez exécuter une commande Upgrade Compatibility Tool avec l’option --vanilla-dir pour spécifier le répertoire d’installation d’Adobe Commerce vanilla.

Voir la rubrique Déployer une instance Vanilla pour plus d’informations.

Utiliser la commande refactor

Le Upgrade Compatibility Tool permet de résoudre automatiquement un ensemble réduit de problèmes :

Pour cela, exécutez la commande refactor :

bin/uct refactor <dir>

Où <dir> valeur correspond au répertoire où se trouve votre instance Adobe Commerce.

Options disponibles pour la commande refactor :

Utiliser la commande graphql:compare

Cette commande permet aux Upgrade Compatibility Tool d’inspecter deux points d’entrée GraphQL et de comparer leurs schémas à la recherche de modifications avec rupture et dangereuses entre eux :

bin/uct graphql:compare <schema1> <schema2>

Où les arguments sont les suivants :

Options disponibles pour la commande graphql:compare :

Utiliser la commande list

Pour renvoyer une liste des commandes Upgrade Compatibility Tool disponibles, exécutez :

bin/uct list

Utiliser la commande help

Pour afficher les options générales et l’aide de la commande Upgrade Compatibility Tool, exécutez :

bin/uct --help

Cette opération renvoie une liste avec toutes les options de help disponibles pour le Upgrade Compatibility Tool dans une interface de ligne de commande :

- --raw             To output raw command list
- --format=FORMAT   The output format (txt, xml, json, or md) [default: "txt"]
- --short           To skip describing commands' arguments
- -h, --help            Display help for the given command. When no command is given display help for the list command
- -q, --quiet           Do not output any message
- -V, --version         Display this application version
- --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
- -n, --no-interaction  Do not ask any interactive question
- -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Il est possible d’exécuter --help en tant qu’option lors de l’exécution d’une commande spécifique. Elle renvoie --help options de la commande spécifiée.

Exemple de la commande upgrade:check avec l'option --help :

bin/uct upgrade:check --help

Cette opération renvoie des options spécifiques qui peuvent être exécutées pour la commande upgrade:check :

- -a, --current-version[=CURRENT-VERSION]: Current Adobe Commerce version, version of the Adobe Commerce installation will be used if omitted.
- -c, --coming-version[=COMING-VERSION]: Target Adobe Commerce version, latest released version of Adobe Commerce will be used if omitted. Provides a list of all available Adobe Commerce versions.
- --json-output-path[=JSON-OUTPUT-PATH]: Path of the file where the output will be exported in json format.
- --html-output-path[=HTML-OUTPUT-PATH]: Path of the file where the output will be exported in HTML format.
- --min-issue-level[=MIN-ISSUE-LEVEL]            Minimal issue level you want to see in the report (warning, error or critical). [default: "warning"]
- -i, --ignore-current-version-compatibility-issues  Ignore common issues for current and coming version
- --context=CONTEXT: Execution context. This option is for integration purposes and does not affect the execution result.
- -h, --help: Display help for that specific command. If no command is provided, `list` command is the default result.
- -q, --quiet: Do not output any messages while executing the command.
- -v, --version: Display application version.
- --ansi, --no-ansi: Enable ANSI output.
- -n, --no-interaction: Do not ask any interactive question while executing the command.
- -v, --vv, --vvv, --verbose: Increase verbosity of output communications. 1 for normal output, 2 for verbose output, and 3 for DEBUG output.

Respect Des Bonnes Pratiques D’Adobe Commerce

Optimisation des résultats

Le Upgrade Compatibility Tool fournit un rapport contenant les résultats avec tous les problèmes identifiés sur votre projet par défaut. Vous pouvez optimiser les résultats afin de vous concentrer sur les problèmes que vous devez résoudre pour terminer la mise à niveau :