JSON file
You can get the JSON file output while running the Upgrade Compatibility Tool on a command-line interface. The JSON
file contains exactly the same information shown on the Upgrade Compatibility Tool output:
- A list of identified issues.
- A summary of the analysis.
For each encountered issue, the report provides detailed information such as the severity and description of the problem.
To export this JSON
file into a different output folder:
bin/uct upgrade:check <dir> --json-output-path[=JSON-OUTPUT-PATH]
Where arguments are as follows:
<dir>
: Adobe Commerce installation directory.[=JSON-OUTPUT-PATH]
: Path directory to export theJSON
output file.
var/output/[TIME]-results.json
.HTML report
You can get the HTML report while running the tool on a command-line interface or through the Site-Wide Analysis Tool. The HTML report also contains:
- A list of identified issues.
- A summary of the analysis.
You can easily navigate through the identified issues during the Upgrade Compatibility Tool analysis.
You can filter issues shown on the report according to the minimum issue level (default value is WARNING
).
There is a dropdown at the top-right corner that allows you to select a different level. The list of identified issues is filtered accordingly.
The HTML report also includes four different charts:
- Modules by issue severity: Shows severity distribution by modules.
- Files by issue severity: Shows severity distribution by files.
- Modules ordered by total number of issues: Shows the 10 most compromised modules taking into account warnings, errors, and critical errors.
- Modules with relative sizes and issues: The more files a module contains, the bigger its circle. The more issues a module has, the more red its circle appears.
These charts allow you to identify the modules that are most compromised and the ones that require more work to perform an upgrade.
The HTML report diagrams are also updated accordingly, with the only exception of the Modules with relative sizes and issues
, which is generated with the min-issue-level
that was orginally set up.
If you want to see different results for the Modules with relative sizes and issues
diagram, you must re-run the command providing another value for the --min-issue-level
option.
To export this HTML report into a different output folder:
bin/uct upgrade:check <dir> --html-output-path[=HTML-OUTPUT-PATH]
Where arguments are as follows:
<dir>
: Adobe Commerce installation directory.[=HTML-OUTPUT-PATH]
: Path directory to export the.html
output file.
var/output/[TIME]-results.html
.