docs: changelog and upgrade #103
Conversation
…MigrationAssistant into docs/changelog-and-upgrade
larskemper
requested review from
DennisGarding,
MalteJanz,
Copilot,
ennasus4sun and
jozsefdamokos
There was a problem hiding this comment.
Pull request overview
This PR documents version 16.0.0 changes for the Shopware Migration Assistant, resolving issue #12625. The documentation includes comprehensive changelog entries and upgrade instructions for breaking changes.
Key changes:
- Complete version 16.0.0 changelog with feature descriptions and breaking changes
- Enhanced README.md with better structure, installation instructions, and developer workflows
- German changelog updates for consistency with English version
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| UPGRADE.md | Documents breaking changes for version 16.0.0 with detailed technical migration instructions for error resolution, API changes, and refactorings |
| README.md | Restructured with improved navigation, clearer sections for documentation, requirements, installation, developer setup, and common workflows |
| CHANGELOG.md | Added high-level feature descriptions for version 16.0.0 including error resolution UI, ACL constraints, validation improvements, and CLI command removals |
| CHANGELOG_de-DE.md | German translation of changelog with formatting corrections and consistency improvements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Added new class `SwagMigrationAssistant\Migration\Mapping\Lookup\TaxLookup` to replace the removed method `getTaxUuid` | ||
| - Added new class `SwagMigrationAssistant\Migration\Mapping\Lookup\SeoUrlTemplateLookup` to replace the removed method `getSeoUrlTemplateUuid` | ||
| - [BREAKING] Added new constructor parameter `LowestRootCategoryLookup $lowestRootCategoryLookup`. `DefaultCmsPageLookup $defaultCmsPageLookup`, `LanguageLookup $languageLookup` to `SwagMigrationAssistant\Profile\Shopware\Converter\CategoryConverter` | ||
| - [BREAKING] Added new constructor parameter `LowestRootCategoryLookup $lowestRootCategoryLookup`, `DefaultCmsPageLookup $defaultCmsPageLookup`, `LanguageLookup $languageLookup` to `SwagMigrationAssistant\Profile\Shopware\Converter\CategoryConverter` |
There was a problem hiding this comment.
Typo: there's an extra backtick after "lowestRootCategoryLookup". The backtick and comma should be: , not .
| - MIG-118 - Korrigiert die Migration der Kredit-Bestellpositionen | ||
| - MIG-120 - Behebt ein Problem beim Laden des Premappings | ||
| - MIG-162 - Behebt ein Problem bei der Migration von Produkten mit leeren Freitextfeldern | ||
| - MIG-162 - Behebt ein Problem bei der Migration von Produkten mit leeren Freitextfeldern |
There was a problem hiding this comment.
Trailing whitespace: This line has trailing whitespace that should be removed for consistency.
| - PT-11113 - Anpassung der Plugin icons | ||
| - PT-11111 - Anpassung des Profilicons für externe Profile | ||
| - NTR - Behebt ein Problem nach dem Installieren von extern Profilen | ||
| - NTR - Behebt ein Problem nach dem Installieren von extern Profilen |
There was a problem hiding this comment.
Trailing whitespace: This line has trailing whitespace that should be removed for consistency.
| - `SwagMigrationAssistant\Migration\Logging\LogCannotConvertChildEntity`, | ||
| - `SwagMigrationAssistant\Migration\Logging\LogCannotConvertEntity`, | ||
| - `SwagMigrationAssistant\Migration\Logging\LogDocumentTypeNotSupported`, | ||
| - `SwagMigrationAssistant\Migration\Logging\LogInvalidUnserializedData`, |
There was a problem hiding this comment.
Duplicate line: Line 179 appears to be a duplicate of the bullet point naming "LogInvalidUnserializedData" which was already mentioned. This line should be removed.
| - `SwagMigrationAssistant\Migration\Logging\LogInvalidUnserializedData`, |
| - Created `SwagMigrationAssistant\Migration\Logging\Log\Builder\MigrationLogBuilder` to build log entries of type `MigrationLogEntry` | ||
| - Added columns to `swag_migration_logging` with `SwagMigrationAssistant\Core\Migration\Migration1754897550AddRequiredFieldsToMigrationLogs`: | ||
| - `entity_name` | ||
| - `entity_id` |
There was a problem hiding this comment.
Missing field in list: The changelog lists "entity_id" as an added column in line 186, but this field is not mentioned in the fields list starting at line 193. For consistency with the UPGRADE documentation pattern, this field should be included in both the columns list and the fields list.
resolves shopware/shopware#12625