下載 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之前必須解決的嚴重問題、錯誤和警告清單。
檢視此 教學影片 (06:02)進一步瞭解 Upgrade Compatibility Tool.
可用的命令 Upgrade Compatibility Tool 在命令列介面中:
upgrade:check
dbschema:diff
core:code:changes
refactor
graphql:compare
list
help
help
的選項 Upgrade Compatibility Tool. 此指令可與先前指令一起執行,也可以與選項一起執行。使用 upgrade:check
命令
此 upgrade:check
命令會檢查該特定Adobe Commerce執行個體的核心程式碼變更,以及其中安裝的所有自訂程式碼變更。
此 upgrade:check
命令是執行工具的主要命令:
bin/uct upgrade:check <dir>
位置 <dir>
值是Adobe Commerce執行個體所在的目錄。
的可用選項 upgrade:check
命令:
upgrade:check
- —help:傳回所有可用選項。
- —current-version:目前的Adobe Commerce版本。 此為必要引數,必須一律使用。
- — 最小問題層級:您可以根據最小問題層級篩選問題(預設值為「警告」)。
- —ignore-current-version-compatibility-issues (或 — i):如果您不想在報表中包含目前版本的嚴重問題、錯誤和警告。
- — 即將推出的版本(或 — c):鎖定特定的Adobe Commerce版本。 如果省略,將使用最新可用的。
此 Upgrade Compatibility Tool 可讓您執行 upgrade:check
命令與 --ignore-current-version-compatibility-issues
選項。 當您只想從目前的版本更新至目標版本時得到新問題,請使用此選項。 Upgrade Compatibility Tool 報告:
bin/uct upgrade:check --ignore-current-version-compatibility-issues <dir>
新增 --coming-version
選項
您可以將目前的Adobe Commerce安裝與任何Adobe Commerce版本進行比較 >=2.3
藉由使用 --coming-version
選項。
執行時,您必須提供版本作為引數 upgrade:check
命令:
bin/uct upgrade:check <dir> -c 2.4.3
位置 -c, --coming-version[=COMING-VERSION]
指Adobe Commerce目標版本。
執行時有一些限制 --coming-version
:
- 此引數是指可識別特定版本Adobe Commerce的任何標籤。
- 必須明確提供此值;僅提供其值無法運作。
- 提供不含任何引號的標籤版本(無單引號或雙引號):
'2.4.1 — 開發'. - 您不應提供比目前已安裝版本舊或比2.3 (目前支援的最舊版本)舊的版本。
使用 dbschema:diff
命令
您可以擷取兩個Adobe Commerce版本的資料庫架構之間的差異。
bin/uct dbschema:diff <current-version> <target-version>
其中引數如下:
<current-version>
:用於比較的任何Adobe Commerce版本。<target-version>
:以及任何Adobe Commerce版本以供比較。
執行範例:
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>
其中引數如下:
<dir>
:Adobe Commerce安裝目錄。<vanilla dir>
:Adobe Commerce vanilla安裝目錄。
的可用選項 core:code:changes
命令:
core:code:changes
--help
:傳回所有可用的 --help
選項。Vanilla安裝
A 香草 安裝是指標對特定發行版本全新安裝指定版本的標籤或分支。
此 bin/uct core:code:changes
command會檢查系統中是否有vanilla執行個體。 如果這是第一次使用vanilla安裝,互動式命令列問題會提示您從Adobe Commerce存放庫下載vanilla專案(https://repo.magento.com/
)。
您可以執行 Upgrade Compatibility Tool 命令與 --vanilla-dir
用於指定Adobe Commerce vanilla安裝目錄的選項。
請參閱 部署vanilla執行個體 主題以取得詳細資訊。
使用 refactor
命令
此 Upgrade Compatibility Tool 能夠自動修正縮減的問題:
- 允許在不傳遞引數的情況下使用,但具有此類使用方式的函式現已棄用。
- 使用方式
$this
在Magento範本中。 - PHP關鍵字的用法
final
在私用方法中。
為此,請執行 refactor
命令:
bin/uct refactor <dir>
位置 <dir>
值是Adobe Commerce執行個體所在的目錄。
的可用選項 refactor
命令:
refactor
--help
:傳回所有可用的 --help
選項。使用 graphql:compare
命令
此指令提供選項給 Upgrade Compatibility Tool 若要內嵌兩個GraphQL端點,並比較其結構描述,以找出兩者之間的重大變更和危險變更:
bin/uct graphql:compare <schema1> <schema2>
其中引數如下:
<schema1>
:現有安裝的端點URL。<schema2>
:Vanilla安裝的端點URL。
的可用選項 graphql:compare
命令:
graphql:compare
--help
:傳回所有可用的 --help
選項。使用 list
命令
若要傳回 Upgrade Compatibility Tool 可用命令,執行:
bin/uct list
使用 help
命令
若要檢視 Upgrade Compatibility Tool 命令一般選項和說明,執行:
bin/uct --help
這會傳回包含所有可用專案的清單 help
的選項 Upgrade Compatibility Tool 在命令列介面中:
- --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最佳實務
- 避免有兩個名稱相同的模組。
- 關注Adobe Commerce 編碼標準.
- Adobe Commerce 2.4 升級指南 最佳實務。
- 執行 Upgrade Compatibility Tool 從 Site-Wide Analysis Tool 的 雲端基礎結構上的Adobe Commerce 專案。
最佳化您的結果
此 Upgrade Compatibility Tool 提供包含結果的報告,其中包含專案中依預設識別的所有問題。 您可以最佳化結果,將重點放在您必須修正才能完成升級的問題上:
- 使用選項
--ignore-current-version-compatibility-issues
當您只想從目前的版本更新至目標版本,而得知 Upgrade Compatibility Tool 報告。 - 新增
--min-issue-level
選項,此設定可設定最低問題層級,以協助僅優先處理升級時最重要的問題。 - 此 Upgrade Compatibility Tool 至少需要2GB RAM才能執行。 建議使用此設定來避免因記憶體不足限制所造成的問題。 此 Upgrade Compatibility Tool 若您執行
upgrade:check
命令低memory_limit
設定。