Add release note for FeatureManagement 3.1.0 #839
Conversation
|
|
||
| ### Changes | ||
|
|
||
| * Exposing FeatureManager and ConfigurationFeatureDefinitionProvider to public. |
There was a problem hiding this comment.
The release notes aren't documentation, so I would be weary of writing something too long here. If it is a long description and you feel it is needed then I would consider one of the two options:
- Write the description in the PR that added it and link to the PR (as you have done).
- Update the readme in the repo.
For release notes I would expect something more succint like
FeatureManagerandConfigurationFeatureDefinitionProviderare now public- Enables usage of external dependency injection containers
- Allows usage of feature manager without requiring dependency injection
| @@ -4,6 +4,21 @@ | |||
| # Microsoft.FeatureManagement.AspNetCore | |||
| [Source code ][source_code_web] | [Package (NuGet)][package_web] | [Samples][samples_web] | [Product documentation][docs] | |||
|
|
|||
| ## 3.1.0 - November 23, 2023 | |||
|
|
|||
| ### Changes | |||
There was a problem hiding this comment.
Bug fixes are changes too. Should this be "Enhancement"? I know this might be copied from the previous one. Can we fix that too?
| * Allows usage of feature manager without requiring dependency injection. | ||
|
|
||
| * Alternative method `AddScopedFeatureManagement` to register the feature management services. | ||
| * Enables the registration of the feature manager and feature filters as scoped services. |
There was a problem hiding this comment.
I kinda expect we say "Added Blazor support.... " somewhere :)
| * Enables the registration of the feature manager and feature filters as scoped services. | ||
|
|
||
| ### Bug Fixes | ||
| * Preserved the behavior in 2.x.x when passing a configuration section to `AddFeatureManagement(configuration)`. ([#308](https://github.com/microsoft/FeatureManagement-Dotnet/issues/308)) |
There was a problem hiding this comment.
How about we explain what the bug is?
Fixed a bug introduced in the previous release where feature flags cannot be loaded from a custom section of configuration.
|
|
||
| ### Bug Fixes | ||
| * Preserved the behavior in 2.x.x when passing a configuration section to `AddFeatureManagement(configuration)`. ([#308](https://github.com/microsoft/FeatureManagement-Dotnet/issues/308)) | ||
| * Preserved the behavior in 2.x.x when there is a contextual filter specified, but there is no appropriate context provided during the feature flag evaluation. ([#313](https://github.com/microsoft/FeatureManagement-Dotnet/issues/313)) |
There was a problem hiding this comment.
Fixed a bug introduced in the previous release where evaluation of a feature flag that references a contextual feature filter may throw an error if the contextual feature filter is not registered or a context is not provided during evaluation.
|
Can you also fix the wrong heading level by the way? |
|
|
||
| * Added [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor) support for [additional security scenarios](https://learn.microsoft.com/en-us/aspnet/core/blazor/security/server/additional-scenarios?view=aspnetcore-7.0#pass-tokens-to-a-server-side-blazor-app). | ||
| * Added `AddScopedFeatureManagement()` method to register the feature manager and feature filters as scoped by default. | ||
| * Allows usage of scoped feature filters with context provider services to mitigate the [security risk](https://learn.microsoft.com/en-us/aspnet/core/blazor/security/server/interactive-server-side-rendering?view=aspnetcore-7.0#ihttpcontextaccessorhttpcontext-in-razor-components) when using `HttpContextAccessor` in Blazor components. |
There was a problem hiding this comment.
This is part of the blazor support. We should drop it.
| * Allows usage of `FeatureManager` without requiring dependency injection. | ||
|
|
||
| * Added [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor) support for [additional security scenarios](https://learn.microsoft.com/en-us/aspnet/core/blazor/security/server/additional-scenarios?view=aspnetcore-7.0#pass-tokens-to-a-server-side-blazor-app). | ||
| * Added `AddScopedFeatureManagement()` method to register the feature manager and feature filters as scoped by default. |
There was a problem hiding this comment.
We should combine above, and tell customers what's the difference of the new API and where to use it. Suggest below:
Added support for server-side Blazor apps, where the following API can be used in place of the existing AddFeatureManagement() API. The new API registers the feature manager and feature filters as scoped services, while the existing API registers them as singletons.
// full signature of the APIIs there a issue we can reference?
|
|
||
| ### Enhancements | ||
|
|
||
| * `FeatureManager` and `ConfigurationFeatureDefinitionProvider` are now public. |
There was a problem hiding this comment.
I thought there was an issue we can reference. Do we have one?
No description provided.