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/）からバニラプロジェクトをダウンロードするように求められます。

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

詳しくは、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 オプションを返します。

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

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 は、プロジェクトでデフォルトで特定されたすべてのイシューの結果を含んだレポートを提供します。 結果を最適化して、アップグレードを完了するために修正が必要な問題に焦点を当てることができます。