Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion 14/umbraco-deploy/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you are upgrading to a new major version you can find the details about the b

## Release History

This section contains the release notes for Umbraco Deploy 13 including all changes for this version.
This section contains the release notes for Umbraco Deploy 14 including all changes for this version.

#### [14.1.4](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.1.4) (October 3rd 2024)

Expand Down
72 changes: 12 additions & 60 deletions 15/umbraco-deploy/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,72 +16,24 @@ If you are upgrading to a new major version you can find the details about the b

## Release History

This section contains the release notes for Umbraco Deploy 13 including all changes for this version.
This section contains the release notes for Umbraco Deploy 15 including all changes for this version.

#### [14.1.1](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.1.1) (August 20th 2024)
#### [15.0.0-rc1](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F15.0.0) (October 11th 2024)

* Support getting artifacts from exploded/expanded `NamedUdiRange` with different entity types
* Fixed typo in `DefaultLegacyDataTypeConfigurationArtifactMigrator` when migrating Color Picker items in v8 format

#### [14.1.0](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.1.0) (August 15th 2024)

* All items from 14.1.0-rc1
* Fixed `Could not create Udi node: {Id} and entity type {EntityType}` exception when exporting tree nodes without children
* Fixed deploy signatures not getting cleared when members are deleted [#230]( https://github.com/umbraco/Umbraco.Deploy.Issues/issues/230)
* Allow members to be deployed when selected as items in a multi-node tree picker [#231](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/231)
* Apply `ExcludedEntityTypes` configuration to disk operations [#232](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/232)
* Fixed issues with partial restore from an external tree that contains more than one entity
* Fixed formatting of trial expiry days and added missing translations [#229](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/229)
* Fixed `Could not get physical path for "umb://template-file/".` exception when deploying/exporting template without physical file on disk

#### [14.1.0-rc1](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.1.0) (July 19th 2024)

* Add migrators to support legacy Grid layout to Block Grid migration
* Fix schema mismatch when saving templates in production runtime mode [#228](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/228)
* Add default migrator to add missing editor UI aliases and update when replacing editor
* Add default migrator to update Data Type configuration
* Support processing Document/Media Type list view keys and add migrator

#### [14.0.2](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.0.2) (July 11th 2024)

* Set trashed state when processing content [#223](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/223)
* Improve exception message when parent can't be found when getting artifact [#216](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/216)
* Add `MaxRequestLength` Deploy setting to break file upload into multiple requests
* Set variant names when creating new content [#222](https://github.com/umbraco/Umbraco.Deploy.Issues/issues/222)

#### [14.0.1](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.0.1) (June 6th 2024)

* Ensure remote tree uses correct entity type (if multiple entities like folders and items are present in a tree):
* `ITransferEntityService.RegisterTransferEntityType(...)` accepts an optional `RemoteTreeDetail` that now exposes the entity type when getting remote entities;
* Fix `GetMaxRequestLength` endpoint (misaligned HTTP method) preventing file transfers/uploads from local environments;
* Fix Data Type deployment due to missing `EditorUiAlias` (requires a schema extraction/Data Type save to fix);
* Fix JSON serialization errors in trigger endpoints (extract and status report);
* Obsolete and hide `NestedContentValueConnector` and add import migrators for unsupported legacy editors by default:
* Adds `ReplaceMediaPickerDataTypeArtifactMigrator` and `ReplaceNestedContentDataTypeArtifactMigrator` artifact migrators to replace the Data Types with the Media Picker v3 and Block List respectively;
* Adds `MediaPickerPropertyTypeMigrator` and `NestedContentPropertyTypeMigrator` property type migrators to ensure content (property data) is migrated as well;
* Support import with unknown UDI types (like macro, macroscript and partial-view-macro);
* Fix JSON serialization error in value connectors for `BlockValue`.

#### [14.0.0](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.0.0) (May 30th 2024)

* Compatibility with Umbraco 14
* See full details of breaking changes under the [Version-specific Upgrade Guide](upgrades/version-specific.md).
* Compatibility with Umbraco 15
* See full details of breaking changes under the [Version-specific Upgrade Guide](upgrades/version-specific.md)
* Removed `AcceptInvalidCertificates` setting (configure `DeployHttpClient` typed client instead)
* Removed `RemoteTreeNode` model (use `RemoteTreeEntity` instead) and `TryParseEntityIdFromNodeIdDelegate` (use `TryParseUdiRangeFromNodeIdDelegate` instead) in `DeployTransferRegisteredEntityTypeDetail`
* Added `MigrateAsync(...)` method to `IPropertyTypeMigrator` and updated `PropertyTypeMigratorBase` and implementations to use async instead

## Deploy Contrib

#### [14.1.0](https://github.com/umbraco/Umbraco.Deploy.Contrib/releases/tag/release-14.1.0) (August 15th 2024)

* All items from 14.1.0-rc1

#### [14.1.0-rc1](https://github.com/umbraco/Umbraco.Deploy.Contrib/releases/tag/release-14.1.0-rc1) (July 19th 2024)

* Add Matryoshka Group Separator artifact migrator [#67](https://github.com/umbraco/Umbraco.Deploy.Contrib/pull/67)
* Add migrators to support DocTypeGridEditor to Block Grid migration [#66](https://github.com/umbraco/Umbraco.Deploy.Contrib/pull/66)
* Fix and enable remaining legacy artifact migrators [#68](https://github.com/umbraco/Umbraco.Deploy.Contrib/pull/68)

#### [14.0.0](https://github.com/umbraco/Umbraco.Deploy.Contrib/releases/tag/release-14.0.0) (May 30th 2024)
#### [15.0.0-rc1](https://github.com/umbraco/Umbraco.Deploy.Contrib/releases/tag/release-15.0.0-rc1) (October 14th 2024)

* Compatibility with Umbraco 14 and Deploy 14.
* Compatibility with Umbraco 15 and Deploy 15
* Removed obsolete (and unused) legacy `PrevaluePropertyValueArtifactMigratorBase`, `CheckBoxListPropertyValueArtifactMigrator` `DropDownListFlexiblePropertyValueArtifactMigrator` and `RadioButtonListPropertyValueArtifactMigrator` migrators, as they are replaced with `PrevalueArtifactMigrator` and property type migrators that support nested/recursive properties (see PR [#71](https://github.com/umbraco/Umbraco.Deploy.Contrib/pull/71))
* Removed `MediaPickerDataTypeArtifactMigrator`, as it is replaced with `ReplaceMediaPickerDataTypeArtifactMigrator` and `DefaultLegacyDataTypeConfigurationArtifactMigrator`
* Removed `MultiNodeTreePickerDataTypeArtifactMigrator`, as it is replaced with `DefaultLegacyDataTypeConfigurationArtifactMigrator`

## Legacy release notes

Expand Down
108 changes: 25 additions & 83 deletions 15/umbraco-deploy/upgrades/version-specific.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,108 +4,50 @@ description: >-
---

# Version Specific Upgrade Details
This article provides specific upgrade documentation for migrating to Umbraco Deploy version 14.

This article provides specific upgrade documentation for migrating to Umbraco Deploy version 15.

{% hint style="info" %}
If you are upgrading to a minor or patch version, you can find the details about the changes in the [Release Notes](../release-notes.md) article.
{% endhint %}

## Version Specific Upgrade Notes History
Version 14 of Umbraco Deploy has a minimum dependency on Umbraco CMS core of `14.0.0`. It runs on .NET 8.

### **Breaking changes**
Version 14 contains some breaking changes. Not many projects are expected to be affected by them, as they are in relevant areas when extending Deploy to support additional entities and/or property editors. For reference though, the full details are listed here:

#### Async methods
Asynchronous methods have been added to the following interfaces (in the CMS `Umbraco.Cms.Core.Deploy` namespace):
- `IContextCache`:
- `GetOrCreateAsync(...)`
- `IDataTypeConfigurationConnector`, `IImageSourceParser`, `ILocalLinkParser` and `IValueConnector`:
- `ToArtifactAsync(...)`
- `FromArtifactAsync(...)`
- `IServiceConnector`:
- `GetArtifactAsync(...)`
- `ProcessInitAsync(...)`
- `ProcessAsync(...)`
- `ExpandRangeAsync(...)`
- `GetRangeAsync(...)`

These methods all have a default implementation that forwards the calls to the synchronous methods (to maintain backwards compatibility). The synchronous methods have been obsoleted and Deploy will now always call the new asynchronous methods. Implementations should be updated to start using those instead.

Within Deploy, the following base classes and methods have been updated to take advantage of the asynchronous methods:
- `ValueConnectorBase`, `RecursiveValueConnectorBase`, `DataTypeConfigurationConnectorBase` and `ServiceConnectorBase`: all synchronous methods are obsoleted and cause compiler errors when directly invoked (to avoid potential deadlocks, because they all forward to the asynchronous methods using `GetAwaiter().GetResult()`);
- All service and value connector implementations inheriting from the above base classes have been updated to use the asynchronous methods as well;
- `builder.DeployDataTypeConfigurationConnectors().AddCustom(...)`: both `toArtifact` and `fromArtifact` parameters now align with the `ToArtifactAsync(...)` and `FromArtifactAsync(...)` method signatures;
- `IArtifactImportExportService.ExportArtifactsAsync(...)`: the artifacts parameter is updated to `IAsyncEnumerable<IArtifact>`, so artifacts are asynchronously created when iterating;
- `IServiceConnector.GetArtifactsAsync(...)` and `IServiceConnectorFactory.GetArtifactsAsync(...)`: these new extension methods call `GetArtifactAsync(...)` on the relevant service connectors and returns `IAsyncEnumerable<IArtifact>`.

#### Signature notification handling
Deploy stores artifact signatures (hashes) in the database to avoid creating the artifact to for example compare them between disk/database or environments. To ensure the signatures are always up-to-date, the `ISignatureService` used custom notification handling via the `RegisterHandler(...)` and `HandleExternalNotification(...)` methods (because Deploy suppresses notifications during deployment). CMS version 12 introduced the `IDistributedCacheNotificationHandler` marker interface and Deploy 12 the `IDeployRefresherNotificationHandler` that will still handle the notifications during deployments. The following methods are therefore removed:
- `RegisterHandler(...)`: register your handler using the standard `builder.AddNotificationHandler<>()` or `builder.AddNotificationAsyncHandler()` method;
- `HandleExternalNotification(...)`: implement your handler using `IDeployRefresherNotificationHandler<TNotification>` or `IDeployRefresherNotificationAsyncHandler<TNotification>`.
Version 15 of Umbraco Deploy has a minimum dependency on Umbraco CMS core of `15.0.0`. It runs on .NET 9.

#### Return type of Data Type configuration has changed to a dictionary
The return type of `IDataTypeConfigurationConnector.FromArtifact()/FromArtifactAsync()` has changed from `object` to `IDictionary<string, object>` to align with the Data Type configuration changes in the CMS (see [PR #13605](https://github.com/umbraco/Umbraco-CMS/pull/13605)). Also, obsoleted methods and default interface implementations on Deploy interfaces have been removed (see [PR #15965](https://github.com/umbraco/Umbraco-CMS/pull/15965)).
### Breaking changes

#### Removed code due to changes in the CMS
The CMS removed support for the legacy Media Picker, Grid layout, Nested Content editors and macros, which means Deploy doesn't provide support for transferring these editors. The following related code has been removed:
- `IGridCellValueConnector`, `IGridCellValueConnector2` and `IGridCellValueConnectorFactory`: including all Grid cell value connector implementations;
- `GridDataTypeConfigurationConnector`, `NestedContentDataTypeConfigurationConnector`;
- `IMacroParser` (in the CMS), `MacroParserBase` and `MacroParser`;
- `MediaPickerValueConnector` and `MacroConnector`.
Version 15 contains breaking changes. The breaking changes appear in areas related to extending Deploy to support additional entities and property editors. For reference though, the full details are listed here:

#### Backoffice related code/Deploy Management API
Due to the new backoffice, all code related to sections, trees, actions, dashboards and models have been removed or updated. The new backoffice components now also use the Deploy Management API for all operations.

#### Permissions
Version 14 now uses permission verbs (instead of single characters/action letters) and upgrading will automatically migrate any existing permissions:

| Letter | Verb |
| -------| --------------------------|
| Q | Deploy.EnvironmentRestore |
| Ψ | Deploy.TreeRestore |
| Ø | Deploy.PartialRestore |
| T | Deploy.QueueForTransfer |
| П | Deploy.Export |
| Џ | Deploy.Import |

##### JSON artifact migrators
The `IArtifactJsonMigrator.Migrate(...)` method now accepts/returns a `JsonNode` value (instead of `JToken`) due to the change from Newtonsoft.Json to System.Text.Json.
#### Async methods

### **Behavior**
Asynchronous methods have been added to the following interfaces:
- `IPropertyTypeMigrator`:
- `MigrateAsync(...)`

#### JSON serialization
Deploy artifacts are serialized as JSON, either stored as schema on disk (UDA files in `umbraco\Deploy\Revision`), exported into a ZIP archive or when being transferred between environments. We aligned with the CMS and migrated to use System.Text.Json (instead of Newtonsoft.Json). Although we've not changed the artifacts themselves, these libraries have [differences in default behavior](https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/migrate-from-newtonsoft?pivots=dotnet-8-0).
These methods all have a default implementation that forwards the calls to the synchronous methods (to maintain backwards compatibility). The synchronous methods have been obsoleted and Deploy will now always call the new asynchronous methods. Implementations should be updated to start using those instead.

#### No-nodes page environment restore
An empty local environment previously had the option to do an environment restore without logging in to the backoffice. This option now redirects you to the backoffice and once logged in, will show a modal to deploy the schema and restore all content from the upstream environment.
- `PropertyTypeMigratorBase` and `GridPropertyTypeMigratorBase`: the synchronous `Migrate(...)` method is obsoleted and causes a compiler error when directly invoked (to avoid potential deadlocks, because it forwards to the asynchronous method using `GetAwaiter().GetResult()`);
- All property type migrator implementations inheriting from the above base classes have been updated to use the asynchronous methods as well.

#### Uploaded files for import
Deploy now uses the `ITemporaryFileService` from the CMS to temporarily store the uploaded ZIP archive to import. This also means the cleanup is handled by the CMS and the 'Delete import archives' Deploy operation and support for the `deploy-deleteimportarchives` trigger file are removed.
#### Removed `AcceptInvalidCertificates` setting

### **Configuration**
The `AcceptInvalidCertificates` setting previously configured the `ServicePointManager` to accept all certificates. However, this class is [obsoleted in .NET 9 and no longer affects `HttpClient`](https://learn.microsoft.com/en-us/dotnet/api/system.net.servicepointmanager?view=net-9.0).

#### Deploy On-prem license key
For Deploy On-premise, configuring the license key has slightly changed, as we introduced additional options for license validation. The product license keys should be moved to the following structure:
Deploy uses a type of client to make HTTP requests between environments and this client can be configured to accept any certificate:

```json
```csharp
builder.Services.AddHttpClient<DeployHttpClient>().ConfigurePrimaryHttpMessageHandler(() => new HttpClientHandler
{
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Deploy.OnPrem": "<LICENSE KEY>"
},

}
}
}
// Only use this for testing purposes or if you have other security in place (e.g. only allow environments to connect over an internal network)
ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator
});
```

#### Transfer forms as content
The setting `TransferFormsAsContent` has moved to `FormsDeploySettings` in the Forms Deploy package. It is still bound to the `Umbraco:Deploy:Settings:TransferFormsAsContent` configuration key (used in previous versions), so it only affects configuration via code.
### Dependencies

* Umbraco CMS dependency was updated to `15.0.0`.

### **Dependencies**
* Umbraco CMS dependency was updated to `14.0.0`.
## Legacy version-specific upgrade notes

## Legacy version specific upgrade notes
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/upgrades/version-specific.md).
You can find the version-specific upgrade notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/11/umbraco-deploy/upgrades/version-specific.md).
12 changes: 10 additions & 2 deletions 15/umbraco-forms/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ If you are upgrading to a new major version, you can find information about the

## Release History

This section contains the release notes for Umbraco Forms 14 including all changes for this version.
This section contains the release notes for Umbraco Forms 15 including all changes for this version.

#### [**15.0.0-rc1**](https://github.com/umbraco/Umbraco.Forms.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F15.0.0) **(Tuesday 8th 2024)**
#### [**15.0.0-rc1**](https://github.com/umbraco/Umbraco.Forms.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F15.0.0) **(October 8th 2024)**

* Compatibility with Umbraco 15
* See full details of breaking changes under the [Version-specific Upgrade Guide](upgrading/version-specific/).
Expand All @@ -29,6 +29,14 @@ This section contains the release notes for Umbraco Forms 14 including all chang
* New "form details picker" providing a single property editor for the selection of form, theme, and redirect.
* Ability to provide custom themes and email templates via razor class libraries.

## Forms Deploy

This Deploy add-on adds support for transferring, restoring, exporting and importing (including migrating between major versions) of Umbraco Forms data.

#### [**15.0.0-rc1**](https://github.com/umbraco/Umbraco.Forms.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F15.0.0) **(October 14th 2024)**

* Compatibility with Umbraco 15 and Deploy 15

## Legacy release notes

You can find the release notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/blob/umbraco-eol-versions/12/umbraco-forms/release-notes.md) and [Umbraco Forms Package page](https://our.umbraco.com/packages/developer-tools/umbraco-forms/).
Loading