[PaaS のみ]{class="badge informative" title="Adobe Commerce on Cloud プロジェクト（Adobeが管理する PaaS インフラストラクチャ）およびオンプレミスプロジェクトにのみ適用されます。"}

Upgrade Compatibility Toolをダウンロード

コマンドライン インターフェイスでUpgrade Compatibility Toolを使用するには、次のコマンドを実行してダウンロードします。

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

ツールに実行可能な権限をchmod コマンドで付与する必要がある場合があります。

chmod +x ./uct/bin/uct

コマンドライン インターフェイスのUpgrade Compatibility Tool

Upgrade Compatibility Toolは、Adobe Commerce カスタマイズされたインスタンスにインストールされているすべてのモジュールを分析して、特定のバージョンと比較するツールです。 最新バージョンのAdobe Commerceにアップグレードする前に対処する必要がある重大な問題、エラー、警告のリストが返されます。

Upgrade Compatibility Toolの詳細については、この​ ビデオチュートリアル ​ （06:02）を参照してください。

コマンドラインインターフェイスでUpgrade Compatibility Toolに使用できるコマンド：

upgrade:check コマンドの使用

upgrade:check コマンドは、特定のAdobe Commerce インスタンスのコアコードの変更と、そのインスタンスにインストールされているすべてのカスタムコードの変更を確認します。

upgrade:check コマンドは、ツールを実行する主なコマンドです。

bin/uct upgrade:check <dir>

ここで、<dir>値は、Adobe Commerce インスタンスが配置されているディレクトリです。

upgrade:check コマンドで使用できるオプション：

Upgrade Compatibility Toolでは、--ignore-current-version-compatibility-issues オプションを指定してupgrade:check コマンドを実行できます。 このオプションは、現在のバージョンからUpgrade Compatibility Tool レポートの対象バージョンへの更新で導入された新しい問題のみを取得する場合に使用します。

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

--coming-version オプションの追加

--coming-version オプションを使用すると、現在のAdobe Commerce インストールを任意のAdobe Commerce バージョン >=2.3と比較できます。

upgrade:check コマンドを実行する場合は、バージョンをパラメーターとして指定する必要があります。

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

ここで、-c, --coming-version[=COMING-VERSION]はAdobe Commerce ターゲットバージョンを指します。

--coming-versionの実行時にはいくつかの制限があります。

dbschema:diff コマンドの使用

2つのAdobe Commerce バージョンのデータベーススキーマの違いを取得できます。

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

引数は次のとおりです。

実行例：

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

core:code:changes コマンドの使用

現在のAdobe Commerce インストールを比較して、Adobe Commerceのコアコードがカスタマイズを実装するために変更されたかどうかを検証できます。 次のコマンドは、コア修正のリストのみを表示します。

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

引数は次のとおりです。

core:code:changes コマンドで使用できるオプション：

バニラのインストール

vanilla​のインストールは、特定のリリースバージョンの指定されたバージョンタグまたはブランチのクリーンインストールです。

bin/uct core:code:changes コマンドは、システムにバニラ インスタンスがあるかどうかを確認します。 Vanilla インストールを初めて使用する場合は、インタラクティブなコマンドラインの質問で、Adobe Commerce リポジトリ（https://repo.magento.com/）からVanilla プロジェクトをダウンロードするよう求められます。

--vanilla-dir オプションを指定してUpgrade Compatibility Tool コマンドを実行し、Adobe Commerce Vanilla インストールディレクトリを指定できます。

詳しくは、​ バニラインスタンスのデプロイ ​ トピックを参照してください。

refactor コマンドの使用

Upgrade Compatibility Toolには、削減された一連の問題を自動的に修正する機能があります。

そのために、refactor コマンドを実行します。

bin/uct refactor <dir>

ここで、<dir>値は、Adobe Commerce インスタンスが配置されているディレクトリです。

refactor コマンドで使用できるオプション：

graphql:compare コマンドの使用

このコマンドは、2つのGraphQL エンドポイントをイントロスペクトし、それらの間の壊れた変化と危険な変化を探しているスキーマを比較するオプションをUpgrade Compatibility Toolに提供します。

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

引数は次のとおりです。

graphql:compare コマンドで使用できるオプション：

list コマンドの使用

使用可能なUpgrade Compatibility Tool個のコマンドのリストを返すには、次を実行します。

bin/uct list

help コマンドの使用

Upgrade Compatibility Tool コマンドの一般的なオプションとヘルプを表示するには、次を実行します。

bin/uct --help

これにより、コマンドラインインターフェイスでUpgrade Compatibility Toolに対して使用可能なすべてのhelp オプションを含むリストが返されます。

- --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

特定のコマンドを実行する場合は、オプションとして--helpを実行できます。 指定したコマンドの--help オプションを返します。

--help オプションを使用したupgrade:check コマンドの例：

bin/uct upgrade:check --help

これは、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.

Adobe Commerceのベストプラクティス

成果の最適化

Upgrade Compatibility Toolは、デフォルトでプロジェクトで特定されたすべての問題を含む結果を含むレポートを提供します。 アップグレードを完了するために修正する必要がある問題に焦点を当てるように、結果を最適化できます。