Skip to content

Commit f6eb872

Browse files
authored
Merge pull request #7038 from umbraco/cms/16-rc
Updates relating to 16.0.0-rc
2 parents b11534b + 97b49c2 commit f6eb872

File tree

3 files changed

+88
-3
lines changed

3 files changed

+88
-3
lines changed

16/umbraco-cms/extending/packages/creating-a-package.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ You can specify package metadata directly in the `csproj` file. Here, is an exam
124124
```xml
125125
<Project Sdk="Microsoft.NET.Sdk">
126126
<PropertyGroup>
127-
. . .
127+
. . .
128128
<Title>CustomWelcomeDashboard</Title>
129129
<Description>Custom welcome dashboard for Umbraco.</Description>
130130
<PackageTags>umbraco plugin package</PackageTags>
@@ -282,7 +282,7 @@ public class CustomPackageMigration : PackageMigrationBase
282282
IShortStringHelper shortStringHelper,
283283
IContentTypeBaseServiceProvider contentTypeBaseServiceProvider,
284284
IMigrationContext context,
285-
IOptions<PackageMigrationSettings> packageMigrationsSettings)
285+
IOptions<PackageMigrationSettings> packageMigrationsSettings)
286286
: base(
287287
packagingService,
288288
mediaService,
@@ -302,6 +302,54 @@ public class CustomPackageMigration : PackageMigrationBase
302302
}
303303
```
304304

305+
If your migration step has a requirement for asynchronous work, you can also inherit from `AsyncPackageMigrationBase`:
306+
307+
```csharp
308+
using Microsoft.Extensions.Options;
309+
using Umbraco.Cms.Core.Configuration.Models;
310+
using Umbraco.Cms.Core.IO;
311+
using Umbraco.Cms.Core.Models.Membership;
312+
using Umbraco.Cms.Core.PropertyEditors;
313+
using Umbraco.Cms.Core.Services;
314+
using Umbraco.Cms.Core.Strings;
315+
using Umbraco.Cms.Infrastructure.Migrations;
316+
using Umbraco.Cms.Infrastructure.Packaging;
317+
318+
namespace Umbraco.Cms.Web.UI.Custom.PackageMigration;
319+
320+
public class CustomPackageAsyncMigration : AsyncPackageMigrationBase
321+
{
322+
323+
public TestMigrationStep2(
324+
IPackagingService packagingService,
325+
IMediaService mediaService,
326+
MediaFileManager mediaFileManager,
327+
MediaUrlGeneratorCollection mediaUrlGenerators,
328+
IShortStringHelper shortStringHelper,
329+
IContentTypeBaseServiceProvider contentTypeBaseServiceProvider,
330+
IMigrationContext context,
331+
IOptions<PackageMigrationSettings> packageMigrationsSettings,
332+
IUserGroupService userGroupService,
333+
IUserService userService)
334+
: base(
335+
packagingService,
336+
mediaService,
337+
mediaFileManager,
338+
mediaUrlGenerators,
339+
shortStringHelper,
340+
contentTypeBaseServiceProvider,
341+
context,
342+
packageMigrationsSettings)
343+
{
344+
}
345+
346+
protected override async Task MigrateAsync()
347+
{
348+
// Use await for asynchronous work.
349+
}
350+
}
351+
```
352+
305353
Here we also added the ZIP file as an embedded resource to the package project.
306354

307355
![ZIP as an embedded resource](<../../../../10/umbraco-cms/extending/packages/images/embeded-resource-props (1).png>)

16/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,22 @@ Use the [general upgrade guide](../) to complete the upgrade of your project.
1919

2020
<details>
2121

22+
<summary>Umbraco 16</summary>
23+
24+
**TinyMCE is removed**
25+
26+
In Umbraco 15, two property editors were available for a rich text editor: TinyMCE and TipTap.
27+
28+
With Umbraco 16, only TipTap is available as an option out of the box. TinyMCE's [change of license](https://github.com/tinymce/tinymce/issues/9453#issuecomment-2327646149) precludes us from shipping it with the MIT-licensed Umbraco CMS.
29+
30+
When upgrading to Umbraco 16, any data types using TinyMCE will be migrated to use TipTap.
31+
32+
To continue to use TinyMCE, a third-party package must be installed prior to the upgrade. This will disable the migration and allow you to continue with TinyMCE.
33+
34+
</details>
35+
36+
<details>
37+
2238
<summary>Umbraco 15</summary>
2339

2440
**Snapshots are removed**

16/umbraco-cms/reference/configuration/loggingsettings.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ The following configuration is available in the Logging settings:
1313
"CMS": {
1414
"Logging": {
1515
"MaxLogAge": "2.00:00:00",
16-
"Directory": "~/CustomLogFileLocation"
16+
"Directory": "~/CustomLogFileLocation",
17+
"FileNameFormat": "UmbracoTraceLog.{0}..json",
18+
"FileNameFormatArguments": "MachineName"
1719
}
1820
}
1921
}
@@ -30,3 +32,22 @@ To increase the maximum age of the entries in the audit log to 48 hours (2 days)
3032
By default, all log files are saved to the `umbraco/Logs` directory. You can define a custom directory for your log files by using the `Directory` key in the Logging settings.
3133

3234
Set the value to `~/LogFiles` to add all log files to a `LogFiles` directory in the root of the file structure.
35+
36+
## FileNameFormat
37+
38+
The default file name format for the Umbraco log file is `UmbracoTraceLog.{0}..json`. The single argument is replaced at runtime with the server's machine name.
39+
40+
If you want to change the file name or include additional arguments, you can amend the format with the `FileNameFormat` setting.
41+
42+
## FileNameFormatArguments
43+
44+
By default the single argument for the log file format name is the server's machine name.
45+
46+
Other or additional arguments can be provided via the `FileNameFormatArguments` setting using a comma-delimited string:
47+
48+
- `MachineName` - the server's name.
49+
- `EnvironmentName` - the ASP.NET environment name such as "Development" or "Production.
50+
51+
So for example, to provide both supported arguments you would configure `MachineName,EnvironmentName`.
52+
53+
The number of arguments provided should match the placeholders in the configured `FileNameFormat`.

0 commit comments

Comments
 (0)