Merge branch 'feature/migration-logging-refactor' into feat/add-validation-of-resolution-values

Author: larskemper

.github/workflows/admin.yaml

@@ -33,8 +33,9 @@ jobs:
             }
       - run: |
           composer -d custom/plugins/${{ github.event.repository.name }} run admin:install
-          composer -d custom/plugins/${{ github.event.repository.name }} run admin:lint
-          composer -d custom/plugins/${{ github.event.repository.name }} run admin:format
+          composer -d custom/plugins/${{ github.event.repository.name }} run lint:admin
+          composer -d custom/plugins/${{ github.event.repository.name }} run format:admin
+          composer -d custom/plugins/${{ github.event.repository.name }} run format:md
 
   stylelint:
     name: Stylelint
@@ -56,7 +57,7 @@ jobs:
             }
       - run: |
           composer -d custom/plugins/${{ github.event.repository.name }} run admin:install
-          composer -d custom/plugins/${{ github.event.repository.name }} run admin:lint:scss
+          composer -d custom/plugins/${{ github.event.repository.name }} run lint:admin:scss
 
   jest:
     name: Jest

CHANGELOG.md

@@ -1,45 +1,127 @@
-# Shopware Migration Assistant (SwagMigrationAssistant)
+# SwagMigrationAssistant
 
-## License
+The Shopware Migration Assistant establishes a connection between a data source and Shopware 6 and guides you step by step through the migration process.
 
-The MIT License (MIT). Please see [License File](LICENSE) for more information.
+It supports migrating numerous datasets (products, manufacturers, customers, …) and updating them at any time. Before a migration starts, the assistant runs a data check and supports creating “mappings” to resolve missing/unassignable data (for example: assign missing manufacturers to a default manufacturer) to avoid data loss.
 
-## Description
+## Overview
 
-The Shopware Migration Assistant establishes a connection between a data source (e.g. Shopware 5 shop) and Shopware 6 and guides you step by step through the migration process.
+- [Documentation](#documentation)
+- [Shopware 5](#shopware-5-migration-connector)
+- [Requirements](#requirements)
+- [Installation](#installation-shopware-6-project)
+- [Developer setup](#developer-setup)
+- [Common workflows](#common-workflows)
+- [Release notes / upgrades](#release-notes--upgrades)
+- [License](#license)
 
-You can migrate numerous datasets – e.g. products, manufacturers, customers, etc. – from your existing shop system to Shopware 6 and update them at any time.
+## Documentation
 
-The assistant also makes it possible to connect two systems in order to make the transition as easy as possible.
+- **User documentation**: [Shopware Migration docs](https://docs.shopware.com/en/migration-en)
+- **Developer documentation**: [Migration Assistant developer docs](https://developer.shopware.com/docs/products/extensions/migration-assistant/)
 
+## Shopware 5: Migration Connector
 
+When migrating from Shopware 5, you can migrate locally or connect via the “Migration Connector” plugin from the Shopware Store:
 
-Once the connection has been established, it saves automatically so that it can be accessed at any time. After the first complete migration, individual datasets can also be migrated or updated as needed.
+- **Migration Connector**: [Shopware Store listing](https://store.shopware.com/de/swag226607479310f/migration-connector.html)
 
+The connector provides API endpoints so Shopware 6 can establish a secure connection to the Shopware 5 shop. Keep it enabled as long as you need updates/delta migrations.
 
+## Requirements
 
-Before the migration takes place, the assistant performs a data check to determine missing or unassignable datasets. Within the scope of this check it may be necessary to create so-called “mapping”, which replaces any missing data with an assignment (e.g. missing manufacturer data automatically reverts to the default manufacturer) – this ensures you can quickly migrate without losing any data.
+- **Shopware**: `shopware/core` (see version here [`composer.json`](composer.json))
+- **Node.js / npm**: required for administration and JS tooling (lint/unit/acceptance)
+- **MySQL client**: required for importing Shopware 5 fixture data (optional)
 
+## Installation (Shopware 6 project)
 
+Expected path (relative to your Shopware 6 project root) for the plugin:
 
-## Info for Shopware 5 users:
+`custom/plugins/SwagMigrationAssistant`
 
-In migrating your Shopware 5 shop, you can either perform the migration locally or use the “Migration Connector” plugin [Link to the plugin](https://store.shopware.com/de/swag226607479310f/migration-connector.html).
+From the shopware root directory:
 
+```bash
+bin/console plugin:refresh
+bin/console plugin:install -a -c SwagMigrationAssistant
+```
 
+Alternatively, use the provided shortcut:
 
-The Migration Connector provides API endpoints that allow Shopware 6 to establish a secure data connection with the active Shopware 5 shop. As long as you are using Shopware 6, you should leave the plugin enabled. This is the only way to update the data at any time.
+```bash
+composer setup
+```
 
+## Developer setup
 
+- **Install JS dependencies** (administration + Jest + Playwright project):
 
-## Get started with the Migration Assistant:
+```bash
+composer npm:init
+```
 
+- **Install git pre-commit hook** (optional):
 
+```bash
+./bin/setup.sh
+```
 
-- Download the Shopware Migration Assistant from the Community Store
-- Activate the plugin in your Shopware 6 installation – this can be done in the Plugin Manager under “Purchases”. Alternatively, you can use the Plugin Manager to upload the plugin ZIP file.
-- The Migration Assistant will then guide you through the migration process.
+## Common workflows
 
-## Documentation
+### Linting & formatting
+
+Run everything (PHP + admin):
+
+```bash
+composer lint
+```
+
+Run individual parts:
+
+```bash
+composer ecs
+composer phpstan
+composer phpunit
+composer admin:lint # eslint
+composer admin:format # prettier
+```
+
+### Tests
+
+- **PHPUnit**:
+
+```bash
+composer phpunit
+```
+
+- **Administration unit tests (Jest)**:
+
+```bash
+composer admin:unit
+```
+
+- **Acceptance tests (Playwright)**:
+
+```bash
+composer admin:acceptance
+```
+
+More details (including Playwright install steps) can be found in the [acceptance tests README](tests/acceptance/README.md).
+
+### Import Shopware 5 fixture database (optional)
+
+This imports `tests/_fixtures/database/sw55.sql` into the database configured in your Shopware root `.env` via `DATABASE_URL`.
+
+```bash
+composer install5db
+```
+
+## Release notes / upgrades
+
+- **Changelog**: [`CHANGELOG.md`](CHANGELOG.md)
+- **Breaking changes**: [`UPGRADE.md`](UPGRADE.md)
+
+## License
 
-If you need further information. You can have a look at our [user documentation](https://docs.shopware.com/en/migration-en) and our [developer documentation](https://developer.shopware.com/docs/products/extensions/migration-assistant/)
+`MIT` See [`LICENSE`](LICENSE).