Skip to content
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.

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

More expressive titles in the change log (Lombiq Technologies: OCORE-199) #16773

Merged
merged 9 commits into from
Sep 21, 2024
26 changes: 20 additions & 6 deletions src/docs/releases/2.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Release date: Not yet released

## Change Logs

### External Authentication Feature
### Users Feature

#### External Authentication Logic Has Been Separated From the Users Feature

We've introduced a new feature called **External Authentication**. This feature has been separated from the existing **Users** feature to improve dependency management and to provide an option to disable external authentication by default. As a result, the **User Registration** feature no longer needs to be enabled unless you specifically want to allow site registration.

Expand Down Expand Up @@ -32,11 +34,13 @@ Also, note the following updates in `ExternalLoginSettings`:
- `UseScriptToSyncRoles` has been renamed to `ExternalLoginSettings.UseScriptToSyncProperties`.
- `SyncRolesScript` has been renamed to `ExternalLoginSettings.SyncPropertiesScript`.

!!! note
!!! warning
When updating recipes to configure `LoginSettings` or `RegistrationSettings`, ensure that the settings reflect the new class structure.

### User Registration Feature

#### User Registration Feature No Longer Required for External Authentication

The **User Registration** feature is no longer required if you only want to enable external authentication.

The following properties of `RegistrationSettings` are now deprecated and will be removed in the next major release:
Expand All @@ -52,17 +56,27 @@ Previously, the `UsersCanRegister` property controlled which types of registrati

### Roles Feature

#### Roles Assignment Permissions Consolidated

In the Roles feature, there were previously `AssignRoles` and `AssignRole_{RoleName}` permissions, alongside the Users feature's `AssignRoleToUsers` and `AssignRoleToUsers_{RoleName}` permissions. As these permissions were redundant and the `AssignRoles` permissions were never actually authorized against, `AssignRoles` and `AssignRole_{RoleName}` have been removed in favor of the latter.

!!! warning
Please review all your recipes and replace occurrences of `AssignRoles` with `AssignRoleToUsers`, and `AssignRole_{RoleName}` with `AssignRoleToUsers_{RoleName}`.

### New **Azure Communication Services SMS** Feature

A new feature was added to allow you to send SMS messages using Azure Communication Services (ACS). Simply enable it then navigate to the admin dashboard > `Configurations` >> `Settings` >> `SMS` to configure the provider. For more information you can refer to the [docs](../reference/modules/Sms.Azure/README.md).
### Azure Communication Services Email Feature

### **Azure Communication Services Email** Feature Update
#### Azure Communication Services Email Feature Name Update

The feature formerly known as **Azure Email Provider** has been renamed to **Azure Communication Services Email** to clarify that it uses ACS, and to use the same naming pattern as the ACS SMS feature (see above).

Additionally, the configuration provider key for the default provider has changed from `OrchardCore_Email_Azure` to `OrchardCore_Email_AzureCommunicationServices`. While the old key (`OrchardCore_Email_Azure`) will continue to bind for backward compatibility, it is scheduled for removal in the next major release. To ensure future compatibility, it is highly recommended to update your configuration to use the new key.

## Added Features

### Azure Communication Services SMS Feature

A new feature was added to allow you to send SMS messages using Azure Communication Services (ACS). Simply enable it then navigate to the admin dashboard > `Configurations` >> `Settings` >> `SMS` to configure the provider. For more information you can refer to the [docs](../reference/modules/Sms.Azure/README.md).

### External Authentication Feature

The new **External Authentication** feature contains common functionality used by multiple external (i.e. non-local) authentication providers (like Microsoft or Google login). See [above](#external-authentication-logic-has-been-separated-from-the-users-feature) for details.