Skip to content

Commit 645a563

Browse files
Update version specific upgrade notes
1 parent 1a68e9b commit 645a563

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

16/umbraco-deploy/upgrades/version-specific.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,52 @@ Version 16 contains breaking changes. The breaking changes appear in areas relat
2121

2222
#### Entity type registration
2323

24-
Entity type registration is simplified by removing client-side concerns from the server and aligning built-in and custom Umbraco CMS entities (like Forms and Commerce).
24+
Entity type registration is simplified by removing client-side concerns from the server and aligning built-in Umbraco CMS and custom entities (like Forms and Commerce).
2525

2626
* `IDiskEntityService.RegisterDiskEntityType(...)` - This now only requires the entity type, removing the `name`, `isUmbracoEntity` and `installedUdisGetter` parameters.
2727
* `ITransferEntityService.RegisterTransferEntityType(...)` - This is also simplified, removing the `name`, `isUmbracoEntity`, `treeAlias`, `matchesRoutePath`, `matchesNodeId` and `entitiesGetter` parameters.
2828

29-
The name was only used in the backoffice, for example, to group items in the transfer queue and schema comparison dashboard. It now uses localizations (`deploy_entityTypes_{entityType}` or `general_{entityType}`), falling back to the plain entity type.
30-
31-
The `isUmbracoEntity` flag was used in the schema comparison dashboard and for setting signatures to fetch entities differently from custom ones. Making `installedUdisGetter` and `entitiesGetter` mandatory could fetch these items, but this is already possible via service connectors (`IServiceConnector.GetRangeAsync()` and `IServiceConnector.GetArtifact()`).
29+
The name was only used in the backoffice, for example, to group items in the transfer queue and schema comparison dashboard. It now uses localizations (`deploy_entityTypes_{entityType}` or `general_{entityType}`), falling back to the plain entity type if no translation is provided.
30+
31+
The `isUmbracoEntity` flag was used when fetching entities in the schema comparison dashboard and for setting signatures. This could only be enabled for built-in Umbraco entities directly supported by Deploy. Custom entities required providing the `installedUdisGetter` or `entitiesGetter` parameter for these features to work correctly. However, getting all entities is already possible via the service connectors (`IServiceConnector.GetRangeAsync()` and `IServiceConnector.GetArtifact()`), making these parameters redundant.
32+
33+
The `treeAlias`, `matchesRoutePath` and `matchesNodeId` parameters were removed because the client-side already keeps track of the entity types. It's recommended to use the same entity types on the client (in workspaces and routes) and server (in UDIs, artifacts and service connectors). In case these are different, Deploy supports mapping the client-side entity types to their server-side counterpart using a `deployEntityTypeMapping` manifest, as shown in the following example:
34+
35+
```json
36+
{
37+
"id": "Umbraco.Commerce.Deploy",
38+
"name": "Umbraco Commerce Deploy",
39+
"version": "16.0.0",
40+
"extensions": [
41+
{
42+
"type": "localization",
43+
"alias": "Uc.Deploy.Localization.En",
44+
"weight": -100,
45+
"name": "English",
46+
"meta": {
47+
"culture": "en",
48+
"localizations": {
49+
"deploy_entityTypes": {
50+
"umbraco-commerce-product-attribute": "Umbraco Commerce Product Attribute",
51+
"umbraco-commerce-product-attribute-preset": "Umbraco Commerce Product Attribute Preset",
52+
}
53+
}
54+
}
55+
},
56+
{
57+
"type": "deployEntityTypeMapping",
58+
"alias": "Uc.Deploy.EntityTypeMapping",
59+
"name": "Umbraco Commerce Deploy Entity Type Mapping",
60+
"entityTypes": {
61+
"uc:product-attribute": "umbraco-commerce-product-attribute",
62+
"uc:product-attributes": "umbraco-commerce-product-attribute",
63+
"uc:product-attribute-preset": "umbraco-commerce-product-attribute-preset",
64+
"uc:product-attribute-presets": "umbraco-commerce-product-attribute-preset"
65+
}
66+
}
67+
]
68+
}
69+
```
3270

3371
### Dependencies
3472

0 commit comments

Comments
 (0)