{"id":13883519,"url":"https://github.com/elgentos/magento2-upgrade-gui","last_synced_at":"2025-06-24T08:02:03.466Z","repository":{"id":42972796,"uuid":"438357439","full_name":"elgentos/magento2-upgrade-gui","owner":"elgentos","description":"Magento 2 Upgrade GUI","archived":false,"fork":false,"pushed_at":"2023-07-04T09:16:27.000Z","size":1616,"stargazers_count":116,"open_issues_count":4,"forks_count":8,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-24T08:01:56.814Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elgentos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-14T18:22:46.000Z","updated_at":"2025-04-10T19:55:11.000Z","dependencies_parsed_at":"2024-06-19T03:08:07.841Z","dependency_job_id":null,"html_url":"https://github.com/elgentos/magento2-upgrade-gui","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/elgentos/magento2-upgrade-gui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elgentos%2Fmagento2-upgrade-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elgentos%2Fmagento2-upgrade-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elgentos%2Fmagento2-upgrade-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elgentos%2Fmagento2-upgrade-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elgentos","download_url":"https://codeload.github.com/elgentos/magento2-upgrade-gui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elgentos%2Fmagento2-upgrade-gui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261632026,"owners_count":23187268,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-08-06T09:01:36.718Z","updated_at":"2025-06-24T08:02:03.384Z","avatar_url":"https://github.com/elgentos.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"# Magento 2 Upgrade GUI\n\nA GUI tool to help you visually and easily spot differences in a three-way comparison between the version you upgraded from, the version you upgraded to, and your Magento preferences, plugins and overrides.\n\nThis is an Electron app to make it easier for you to read and process the output files of the [Ampersand Magento2 Upgrade Patch Helper](https://github.com/AmpersandHQ/ampersand-magento2-upgrade-patch-helper).\n\nOn the left, it will show the differences between the files of your previous Magento version and the version you upgraded to.\n\nOn the right, it will show the customization (override/preference/plugin) in your project and third party extensions. \n\nThis will allow you to quickly see differences and to assess whether this change is relevant for your customization.\n\n![App home](https://user-images.githubusercontent.com/431360/191521244-7bbb85e7-9ec6-492a-9570-8b458f8134ce.png)\n\n## Instructions\n\nTo use this app, you will need the following files in your Magento 2 directory;\n- `vendor` (regular composer directory)\n- `vendor.patch` (generated by the upgrade patch helper)\n- `vendor_files_to_check.patch` (generated by the upgrade patch helper)\n- `patch-helper-output.txt` (the output generated by the upgrade patch helper, directed from stdout to a file)\n- `classmap.json` (see below)\n\nYou will need to generate the `classmap.json` file yourself. This is needed because the tool needs to map PSR-4 classnames to actual filenames, which Composer can do for us. Run these commands to generate the file;\n\n```bash\ncomposer dump --classmap-authoritative\nphp -r \"\\$classmap=require_once('vendor/composer/autoload_classmap.php'); echo json_encode(\\$classmap);\" \u003e classmap.json\n```\n\n## Output\n\nWhen you open up a project directory, the GUI will create 3 result files in the Magento 2 root directory; `warnings.json`, `infoNotices.json` and `results.md`. The `warnings.json` file is used to track state so you can close the GUI and continue working on the project. The Markdown file resembles that state, but in a nice Markdown format you can paste it into your issue management system to keep your colleagues uptodate.\n\n## Screenshots\n\n![Editor](https://user-images.githubusercontent.com/431360/191521234-0a9c4473-5a71-47ef-bd2e-ccbe45513deb.png)\n\n![Instructions page](https://user-images.githubusercontent.com/431360/191521238-37d47cf9-893e-428c-9a61-7730387929d0.png)\n\n## Installation\n\nDownload the `AppImage` file from the [releases](https://github.com/elgentos/magento2-upgrade-gui/releases) page. Make it executable (with `chmod +x`) and run it!\n\n## Git auto-commit\n\nIf you have this feature enabled (default), it will add the file to the git stage and commit to your repository when you click \"Resolve\". Enabling/disabling this feature and the commit message can be changed in the Settings screen.\n\n## GitLab integration\n\nBy setting a few config settings, you can auto-update an issue with your progress. The GUI will create a note on the issue with a Markdown table. It will then update that note when an item is changed.\n\nYou can set these settings in the Settings screen.\n\n![Settings page](https://user-images.githubusercontent.com/431360/191521240-15d626eb-dfc0-496d-9728-57cd834d2b6d.png)\n\nThe output in Gitlab will look like this:\n\n![image](https://user-images.githubusercontent.com/431360/188888302-46c79be9-d499-4dcf-b71a-7359d09bdcf3.png)\n\n## Config file\n\nThe config file will be created when the app first starts.\n\n```\n{\n    \"gitlab\": {\n            \"host\": \"https://gitlab.com\",\n            \"token\": \"xxxxxxxxxxxxxxxxx\",\n            \"project_id\": \"123\",\n            \"issue_id\": \"123\"\n    },\n    \"git\": {\n            \"auto_commit\": true,\n            \"auto_commit_message\": \"Upgrade: resolved %s\"\n    }\n}\n```\n\nIt is stored in your home dir, but the location differs per OS. On Linux, it is `~/.config/magento2-upgrade-gui/config.json`.\n\n## PhpStorm integration\n\nIf you have the [IDE Remote Control](https://plugins.jetbrains.com/plugin/19991-ide-remote-control) plugin installed (PhpStorm 2022.3 and later) and the project open, you can click on the file path on the right hand side (or on the \"Original vendor file\" and \"New vendor file\" links on the left hand side) to have it open the file in PhpStorm. To disable JetBrains warning `'file' API is requested. Do you trust unknown host?`, you can go to `File \u003e Settings \u003e Build, Execution, Deployment \u003e Debugger` and Check the `Allow unsigned requests` in the Built-in Server section.\n\n## Development\n\nClone this repo and run this command to install all necessary dependencies:\n\n```\nyarn install\n```\n\nTo start developing the app, you can run:\n\n```\nNODE_ENV=development yarn electron:serve\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felgentos%2Fmagento2-upgrade-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felgentos%2Fmagento2-upgrade-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felgentos%2Fmagento2-upgrade-gui/lists"}