Skip to content

Add Deploy 4.9, 10.3, 12.1 and 13.0 release notes and configuration details for TrashedContentDeploymentOperations #5732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add Deploy 4.9, 10.3, 12.1 and 13.0 release notes and configuration details for TrashedContentDeploymentOperations #5732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
048d071
Update 4.9, 10.3, 12.1 and 13.0 release notes
ronaldbarendse Dec 22, 2023
58aaaef
Add configuration details for TrashedContentDeploymentOperations
ronaldbarendse Dec 22, 2023
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
75 changes: 36 additions & 39 deletions 13/umbraco-deploy/deploy-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ For illustration purposes, the following structure represents the full set of op
"ApiKey": "<your API key here>",
"ApiSecret": "<your API secret here>",
"Edition": "Default",
"DefaultTimeoutSeconds": 60,
Copy link
Contributor Author

@ronaldbarendse ronaldbarendse Dec 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't a configurable setting, but a read-only constant field with the default timeout used by other settings...

Copy link
Contributor

@alina-tincas alina-tincas Dec 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, makes sense! should I remove this setting in all other deploy versions as well?

Copy link
Contributor

@alina-tincas alina-tincas Jan 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and would it perhaps make better sense to remove this setting and add a warning or info note at the end of the "timeout settings" https://docs.umbraco.com/umbraco-deploy/v/12.deploy.latest/deploy-settings#timeout-settings that "DefaultTimeoutSeconds is set to default of 60 seconds. This isn't a configurable setting, but a read-only constant field with the default timeout used by other settings"?

Copy link
Contributor Author

@ronaldbarendse ronaldbarendse Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DefaultTimeoutSeconds should be removed from the documentation for all versions, because it's not a setting at all and because it's an internal constant, also isn't available externally (besides actually being set to 20 * 60, so 20 minutes, which is already documented in the timeout settings section).

"ExcludedEntityTypes": [],
"RelationTypes" : [],
"ValueConnectors": [],
Expand All @@ -60,13 +59,14 @@ For illustration purposes, the following structure represents the full set of op
"ExportMemberGroups": true,
"ReloadMemoryCacheFollowingDiskReadOperation": false,
"AllowDomainsDeploymentOperations": "None",
"AllowWebhooksDeploymentOperations": "None",
"TrashedContentDeploymentOperations": "Import",
"PreferLocalDbConnectionString": false,
"MediaFileChecksumCalculationMethod": "PartialFileContents",
"NumberOfSignaturesToUseAllRelationCache": 100,
"ContinueOnMediaFilePathTooLongException": false,
"SuppressCacheRefresherNotifications": false,
"HideConfigurationDetails": false,
"AllowWebhooksDeploymentOperations": "None"
"HideConfigurationDetails": false
}
}
}
Expand Down Expand Up @@ -98,7 +98,7 @@ However, we are aware that some customers prefer the option to use the backoffic
This setting allows you to exclude a certain type of entity from being deployed. This is **not** recommended to set, but sometimes there may be issues with the way a custom media fileprovider works with your site and you will need to set it for media files. Here is an example:

```json
"ExcludedEntityTypes": ['media-file'],
"ExcludedEntityTypes": ["media-file"],
Copy link
Contributor

@alina-tincas alina-tincas Jan 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be changed only for v13 or for all versions?

Copy link
Contributor Author

@ronaldbarendse ronaldbarendse Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be updated for all versions, because for JSON to be 100% valid, it needs to use double quotes 😄

```

### RelationTypes
Expand All @@ -109,28 +109,15 @@ This setting allows you to manage how relations are deployed between environment
* `Weak` - This causes the relation to be deployed if both content items are found on the target environment.
* `Strong` - This requires the content item that is related is set as a dependency, so if anything is added as a relation it would also add it as a dependency.

```json
"RelationTypes": [
{
"Alias": "relateParentDocumentOnDelete",
"Mode": "Weak",
},
{
"Alias": "relateShopItemOnCreate",
"Mode": "Exclude",
}
],
Comment on lines -113 to -122
Copy link
Contributor Author

@ronaldbarendse ronaldbarendse Dec 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The format of this setting has changed in v13 (see breaking changes) and is already shown below...

Copy link
Contributor

@alina-tincas alina-tincas Jan 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be removed only for v13 or for all versions?

Copy link
Contributor Author

@ronaldbarendse ronaldbarendse Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only for v13, as that uses the format that's already shown below.

```

As of Deploy 10.1.2 and 11.0.1, if this setting is left blank, the two relation types used for usage tracking are omitted. These are rebuilt by the CMS following a save of an item in the target environment and so don't need to be transferred. Unless you have specified otherwise, the effective default configuration is:

```json
"RelationTypes": {
"relateParentDocumentOnDelete": "Weak",
"relateShopItemOnCreate": "Exclude"
},
```

As of Deploy 10.1.2, 11.0.1 and higher, if this setting is left blank, the relation types used for usage tracking are omitted. These relations are rebuilt by the CMS following a save of an item in the target environment and so don't need to be transferred.

If a particular relation type is not listed, it's considered as a "weak" relation.

### ValueConnectors
Expand Down Expand Up @@ -251,22 +238,22 @@ To configure the behavior you prefer, amend this value to either `None`, `Transf
For example, using the following settings, you will have an installation that ignores broken dependencies when restoring from an upstream environment. It will however still prevent deployment and report any dependency issues when attempting a transfer to an upstream environment.

```json
"IgnoreBrokenDependenciesBehavior": "Restore",
"IgnoreBrokenDependenciesBehavior": "Restore",
```

When configuring for Deploy 9, an additional `IgnoreBrokenDependencies` setting existed that took a value of `true` or `false`. To achieve the same result as the example above, the following configuration was required:

```json
"IgnoreBrokenDependencies": true,
"IgnoreBrokenDependenciesBehavior": "Restore",
"IgnoreBrokenDependencies": true,
"IgnoreBrokenDependenciesBehavior": "Restore",
```

### Memory cache reload

Some customers have reported intermittent issues related to Umbraco's memory cache following deployments, which are resolved by a manual reload of the cache via the _Settings > Published Status > Caches_ dashboard. If you are running into such issues and are able to accommodate a cache clear after deployment, this workaround can be automated via the following setting:

```json
"ReloadMemoryCacheFollowingDiskReadOperation": true,
"ReloadMemoryCacheFollowingDiskReadOperation": true,
```

By upgrading to the most recent available version of the CMS major you are running, you'll be able to benefit from the latest bug fixes and optimizations in this area. That should be your first option if encountering cache related issues. Failing that, or if a CMS upgrade is not an option, then this workaround can be considered.
Expand All @@ -276,14 +263,14 @@ By upgrading to the most recent available version of the CMS major you are runni
Culture and hostname settings, defined per content item for culture invariant content, are not deployed between environments by default but can be opted into via configuration.

```json
"AllowDomainsDeploymentOperations": "None|Culture|AbsolutePath|Hostname|All",
"AllowDomainsDeploymentOperations": "None|Culture|AbsolutePath|Hostname|All",
```

To enable this, set the configuration value as appropriate for the types of domains you want to allow:

* _Culture_ - the language setting for the content, defined under "Culture"
* _AbsolutePath_ - values defined under "Domains" with an absolute path, e.g. "/en"
* _Hostname_ - values defined under "Domains" with a full host name, e.g. "en.mysite.com"
* `Culture` - the language setting for the content, defined under "Culture"
* `AbsolutePath` - values defined under "Domains" with an absolute path, e.g. "/en"
* `Hostname` - values defined under "Domains" with a full host name, e.g. "en.mysite.com"

Combinations of settings can be applied, e.g. `Hostname,AbsolutePath`.

Expand All @@ -292,13 +279,28 @@ Combinations of settings can be applied, e.g. `Hostname,AbsolutePath`.
Webhooks may be considered environment specific or schema information that you would like to synchronize between environments. As such, by default, Umbraco Deploy does not include webhooks in schema deployment operations.

```json
"AllowWebhooksDeploymentOperations": "None|All",
"AllowWebhooksDeploymentOperations": "None|All",
```

If you would like you include them you can adjust this setting:

* _None_ - webhooks are not deployed and are expected to be managed independently in each environment.
* _All_ - webhooks included in schema deployments.
* `None` - webhooks are not deployed and are expected to be managed independently in each environment.
* `All` - webhooks included in schema deployments.

## Deployment of trashed content

Specifies options for handling trashed content (documents, media and members) on export or import:

```json
"TrashedContentDeploymentOperations": "None|Export|Import|All"
```

You can amend this behavior using this setting:

* `None` - trashed content will not be exported or imported
* `Export` - trashed content will be included in an export
* `Import` - trashed content will be processed and moved to the recycle bin on import
* `All` - trashed content will be included in an export, processed and moved to the recycle bin on import

### PreferLocalDbConnectionString

Expand All @@ -309,13 +311,7 @@ For Umbraco 10, by default, a SQLite database is created.
If you would prefer to use SQL Server LocalDb when it's available on your local machine, set this value to `true`. If LocalDB isn't reported as being available by Umbraco, it will fallback to using a SQLite database instead.

```json
"Umbraco": {
"Deploy": {
"Settings": {
"PreferLocalDbConnectionString": true
}
}
}
"PreferLocalDbConnectionString": true
Copy link
Contributor

@alina-tincas alina-tincas Jan 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be changed only for v13 or for all versions?

Copy link
Contributor Author

@ronaldbarendse ronaldbarendse Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be updated for all versions: other code examples also don't show the Umbraco:Deploy:Settings part (as that's already mentioned at the top of the article)...

```

### MediaFileChecksumCalculationMethod
Expand Down Expand Up @@ -358,15 +354,16 @@ If set to `true` the configuration details shown on the setting's dashboard will

### Webhook Events

Umbraco Deploy can optionally register events that you can use with Umbraco webhooks. You can add them via code, for which we provide an extension method. The following example shows how you can use this within a composer.
Umbraco Deploy can optionally register events that you can use with Umbraco webhooks. You can add them via code, for which we provide an extension method. The following example shows how you can use this within a composer.

```csharp
using Umbraco.Cms.Core.Composing;
using Umbraco.Deploy.Infrastructure.Extensions;

public class RegisterDeployWebhooksComposer : IComposer
{
public void Compose(IUmbracoBuilder builder) => builder.WebhookEvents().AddDeploy(deployBuilder => deployBuilder.AddTask());
public void Compose(IUmbracoBuilder builder)
=> builder.WebhookEvents().AddDeploy(deployBuilder => deployBuilder.AddTask());
}
```

Expand Down
81 changes: 73 additions & 8 deletions 13/umbraco-deploy/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,33 +20,71 @@ Under each major version, you can find details about minor and patch releases fo

<summary>Version 13</summary>

[**13.0.0-rc3**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0)
(November 28th 2023)
[**13.0.1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.1) **(December 21th 2023)**

* Fixes the display of the selected schedule date on queue for transfer.
* Fixes parsing property values within Nested Content and Block List that were previously saved by the Contrib value connectors.
* Fixed incorrectly including media files in export when 'Content files' wasn't selected.
* Add maximum file size validation to import file upload.

[**13.0.0**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0) **(December 14th 2023)**

* All items from the 13.0.0 RCs and latest 12.2 features.

[**13.0.0-rc5**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0) **(December 12th 2023)**

* Align with latest CMS RC.

[**13.0.0-rc4**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0) **(December 11th 2023)**

* Add weight -100 to Deploy package migration (ensuring Deploy database tables are available before other package migrations are executed).
* Add fluent API for Deploy webhooks.

[**13.0.0-rc3**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0) **(November 29th 2023)**

* Added optional deployment of webhooks as part of schema updates.
* Added Deploy specific webhook events.

[**13.0.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0)
(November 6th 2023)
[**13.0.0-rc2**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0) **(November 15th 2023)**

* Compatibility with Umbraco 13
* Exclude automatic relation type aliases (used for reference tracking) from deployment.
* Fix cyclic dependency between configuring `DeploySettings` and `ConnectionStrings`.

[**13.0.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.0.0) **(November 6th 2023)**

* Compatibility with Umbraco 13:
* See full details of breaking changes under the [version specific upgrade guide](upgrades/version-specific.md).
* Update Richtext value connector to handle references in blocks.

</details>

<details>

<summary>Version 12</summary>

[**12.1.0**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.1.0) **(December 11th 2023)**
[**12.2.1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.2.1) **(December 21th 2023)**

* Fixes the display of the selected schedule date on queue for transfer.
* Fixes parsing property values within Nested Content and Block List that were previously saved by the Contrib value connectors.
* Fixed incorrectly including media files in export when 'Content files' wasn't selected.
* Add maximum file size validation to import file upload.

[**12.1.0**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.1.0) **(December 11th 2023)**

* All items from 12.1.0-rc1.
* Fixed a regression in 12.1.0-rc1 where content restore/transfers didn't use the same JSON converters when deserializing Deploy artifacts.
* Fixed permissions not being correctly set for administrators on initial install.
* Moved permissions from the Content to a new Deploy category (only affecting the UI).
* Add support for migrating property values within Nested Content, Block List and Block Grid, and include Multi URL Picker value connector (an explicit value connector binding is used to override the ones provided in Deploy Contrib).
* Added new configuration option of `TrashedContentDeploymentOperations` to allow exporting/importing of trashed content, ensuring referenced content in the recycle bin isn't exported by default and otherwise imports back into the recycle bin.
* Changed the default value connector to use the property storage type, instead of using custom value prefixes to store the object type.

[**12.1.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.1.0) **(November 27th 2023)**
[**12.1.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.1.0) **(November 27th 2023)**

* Added feature of [content import and export with migrations](./deployment-workflow/import-export.md).
* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](./deploy-settings.md)).
* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](./deploy-settings.md)).
* Improve performance of publishing multi-language content during restore/transfer and import.

[**12.0.5**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F12.0.5) (**November 14th 2023**)

Expand Down Expand Up @@ -188,15 +226,29 @@ Under each major version, you can find details about minor and patch releases fo

<summary>Version 10</summary>

[**10.3.0**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.3.0) **(December 11th 2023)**
[**10.3.1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.3.1) **(December 21th 2023)**

* Fixes the display of the selected schedule date on queue for transfer.
* Fixes parsing property values within Nested Content and Block List that were previously saved by the Contrib value connectors.
* Fixed incorrectly including media files in export when 'Content files' wasn't selected.
* Add maximum file size validation to import file upload.

[**10.3.0**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.3.0) **(December 11th 2023)**

* All items from 10.3.0-rc1.
* Fixed a regression in 10.3.0-rc1 where content restore/transfers didn't use the same JSON converters when deserializing Deploy artifacts.
* Fixed permissions not being correctly set for administrators on initial install.
* Moved permissions from the Content to a new Deploy category (only affecting the UI).
* Add support for migrating property values within Nested Content, Block List and Block Grid, and include Multi URL Picker value connector (an explicit value connector binding is used to override the ones provided in Deploy Contrib).
* Added new configuration option of `TrashedContentDeploymentOperations` to allow exporting/importing of trashed content, ensuring referenced content in the recycle bin isn't exported by default and otherwise imports back into the recycle bin.
* Changed the default value connector to use the property storage type, instead of using custom value prefixes to store the object type.

[**10.3.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.3.0) **(November 27th 2023)**

* Added feature of [content import and export with migrations](./deployment-workflow/import-export.md).
* Added a new configuration option of `ResolveUserInTargetEnvironment` to allow resolving of user accounts in target environments (see [Deploy Settings](./deploy-settings.md)).
* Added a new configuration option of `AllowPublicAccessDeploymentOperations` to amend the behavior of public access rule transfer (see [Deploy Settings](./deploy-settings.md)).
* Improve performance of publishing multi-language content during restore/transfer and import.

[**10.2.7**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.2.7) (**November 14th 2023**)

Expand Down Expand Up @@ -461,9 +513,22 @@ Under each major version, you can find details about minor and patch releases fo

<summary>Version 4</summary>

[**4.9.1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F4.9.1) **(December 21th 2023)**

* Fixes the display of the selected schedule date on queue for transfer.
* Fixes parsing property values within Nested Content and Block List that were previously saved by the Contrib value connectors.
* Fixed incorrectly including media files in export when 'Content files' wasn't selected.
* Add maximum file size validation to import file upload.

[**4.9.0**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F4.9.0) **(December 11th 2023)**

* All items from 4.9.0-rc1.
* Fixed a regression in 4.9.0-rc1 where content restore/transfers didn't use the same JSON converters when deserializing Deploy artifacts.
* Fixed permissions not being correctly set for administrators on initial install.
* Moved permissions from the Content to a new Deploy category (only affecting the UI).
* Add support for migrating property values within Nested Content and Block List, and include Multi URL Picker value connector (an explicit value connector binding is used to override the ones provided in Deploy Contrib).
* Added new configuration option of `TrashedContentDeploymentOperations` to allow exporting/importing of trashed content, ensuring referenced content in the recycle bin isn't exported by default and otherwise imports back into the recycle bin.
* Changed the default value connector to use the property storage type, instead of using custom value prefixes to store the object type.

[**4.9.0-rc1**](https://github.com/umbraco/Umbraco.Deploy.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F4.9.0) **(November 27th 2023)**

Expand Down