From 4f5fdac55e0c14277657a6d14ee2d780035b888c Mon Sep 17 00:00:00 2001 From: Zhiyuan Liang <141655842+zhiyuanliang-ms@users.noreply.github.com> Date: Mon, 20 Jan 2025 10:48:02 +0800 Subject: [PATCH] Release note for JS FM v2 (#1008) * release js fm v2 * update * update * update --- releaseNotes/AzureDevOpsPipelineExtension.md | 2 +- releaseNotes/JavaScriptFeatureManagement.md | 26 +++++++++++++++++-- ...ureManagementApplicationInsightsBrowser.md | 12 ++++++++- ...eatureManagementApplicationInsightsNode.md | 10 +++++++ releaseNotes/JavaScriptProvider.md | 6 ++--- releaseNotes/KubernetesProvider.md | 8 +++--- releaseNotes/Microsoft.Featuremanagement.md | 16 ++++++------ ...icrosoftAzureAppConfigurationAspNetCore.md | 2 +- 8 files changed, 62 insertions(+), 20 deletions(-) diff --git a/releaseNotes/AzureDevOpsPipelineExtension.md b/releaseNotes/AzureDevOpsPipelineExtension.md index 2061efc7..c4962c34 100644 --- a/releaseNotes/AzureDevOpsPipelineExtension.md +++ b/releaseNotes/AzureDevOpsPipelineExtension.md @@ -22,7 +22,7 @@ The Azure App Configuration extension in Azure DevOps pipeline has been publishe - Updated the task to require Node.js 16. It previously required 10. - Updated the minimum supported azure pipeline agent version to [2.206.1](https://github.com/microsoft/azure-pipelines-agent/releases/tag/v2.206.1) or later. Previously it was [2.144.0](https://github.com/microsoft/azure-pipelines-agent/releases/tag/v2.144.0). -**Bug fixes** +**Bug Fixes** - Fixed a bug that caused an invalid secret URL warning when resolving key vault references in sovereign clouds. ### v5.2.0 - March, 02 2022 diff --git a/releaseNotes/JavaScriptFeatureManagement.md b/releaseNotes/JavaScriptFeatureManagement.md index 7f1c067b..f3b1652a 100644 --- a/releaseNotes/JavaScriptFeatureManagement.md +++ b/releaseNotes/JavaScriptFeatureManagement.md @@ -2,6 +2,28 @@ [Source code][source_code] | [Package (npm)][package] | [Samples][samples] +## 2.0.0 - Jan 14, 2025 + +### Enhancements + +This is the first stable release of the following features. + +* __Variant Feature Flags__ + + A variant feature flag is an enhanced feature flag that supports multiple states or variations. While it can still be toggled on or off, it also allows for different configurations, ranging from simple primitives to complex JSON objects. Variant feature flags are particularly useful for feature rollouts, configuration rollouts, and feature experimentation (also known as A/B testing). + + The new `getVariant` method of `FeatureManager` has been introduced to evaluate the assigned variant based on the variant feature flag configuration and targeting context. [#13](https://github.com/microsoft/FeatureManagement-JavaScript/pull/13) + +* __Feature Evaluation Telemetry__ + + Telemetry provides observability into flag evaluations, offering insights into which users received specific flag results. This enables more powerful metric analysis, such as experimentation. + + The new `onFeatureEvaluated` property of `FeatureManagerOptions` allows you to set a custom callback for all feature evaluations. This hook can be used to publish telemetry. You can call `createTelemetryPublisher` API from `@microsoft/feature-management-applicationinsights-browser` and `@microsoft/feature-management-applicationinsights-node` packages to publish feature evaluation event to Application Insights. [#36](https://github.com/microsoft/FeatureManagement-JavaScript/pull/36) + +### Bug Fixes + +* Fixed a bug that caused error when calling `getFeatureFlags` and `listFeatureNames`. [#74](https://github.com/microsoft/FeatureManagement-JavaScript/issues/74) + ## 2.0.0-preview.3 - Oct 24, 2024 ### Enhancements @@ -16,9 +38,9 @@ ### Enhancements -* Added support for variant feature flags. A variant feature flag is an enhanced feature flag that supports multiple states or variations. While it can still be toggled on or off, it also allows for different configurations, ranging from simple primitives to complex JSON objects. Variant feature flags are particularly useful for feature rollouts, configuration rollouts, and feature experimentation (also known as A/B testing). +* Added support for variant feature flags. A variant feature flag is an enhanced feature flag that supports multiple states or variations. While it can still be toggled on or off, it also allows for different configurations, ranging from simple primitives to complex JSON objects. Variant feature flags are particularly useful for feature rollouts, configuration rollouts, and feature experimentation (also known as A/B testing). [#13](https://github.com/microsoft/FeatureManagement-JavaScript/pull/13) -* Added support for telemetry in feature flags. Telemetry is a powerful feature that allows you to track how your feature flags are being used. It provides insights into the effectiveness of your feature flags and helps you make data-driven decisions. Telemetry is particularly useful for feature experimentation (also known as A/B testing) and feature rollouts. +* Added support for telemetry in feature flags. Telemetry is a powerful feature that allows you to track how your feature flags are being used. It provides insights into the effectiveness of your feature flags and helps you make data-driven decisions. Telemetry is particularly useful for feature experimentation (also known as A/B testing) and feature rollouts. [#36](https://github.com/microsoft/FeatureManagement-JavaScript/pull/36) ## 1.0.0 - Sep 26, 2024 diff --git a/releaseNotes/JavaScriptFeatureManagementApplicationInsightsBrowser.md b/releaseNotes/JavaScriptFeatureManagementApplicationInsightsBrowser.md index a24abdae..8c11c043 100644 --- a/releaseNotes/JavaScriptFeatureManagementApplicationInsightsBrowser.md +++ b/releaseNotes/JavaScriptFeatureManagementApplicationInsightsBrowser.md @@ -2,13 +2,23 @@ [Source code][source_code] | [Package (npm)][package] | [Samples][samples] +## 2.0.0 - Jan 14, 2025 + +### Enhancements + +This is the first stable release of the following features. + +* A `createTelemetryPublisher` function that has been added that enables feature evaluation telemetry to be published to Application Insights. + +* A `TrackEvent` function has been added to enable sending custom events embedded with targeting information to Application Insights. This function is meant to be used in place of the Application Insights package's standard `TrackEvent` call. + ## 2.0.0-preview.3 - Nov 8, 2024 * Updated `@microsoft/feature-management` dependency to `2.0.0-preview.3`. See the [release notes](./JavaScriptFeatureManagement.md) for more information on the changes. ## 2.0.0-preview.2 - Oct 24, 2024 -### Bug Fix +### Bug Fixes * Fixed a bug that caused `TargetingId` in telemetry to be "undefined". [#59](https://github.com/microsoft/FeatureManagement-JavaScript/pull/59) diff --git a/releaseNotes/JavaScriptFeatureManagementApplicationInsightsNode.md b/releaseNotes/JavaScriptFeatureManagementApplicationInsightsNode.md index cacf441c..4241e221 100644 --- a/releaseNotes/JavaScriptFeatureManagementApplicationInsightsNode.md +++ b/releaseNotes/JavaScriptFeatureManagementApplicationInsightsNode.md @@ -2,6 +2,16 @@ [Source code][source_code] | [Package (npm)][package] | [Samples][samples] +## 2.0.0 - Jan 14, 2025 + +### Enhancements + +This is the first stable release of the following features. + +* A `createTelemetryPublisher` function that has been added that enables feature evaluation telemetry to be published to Application Insights. + +* A `TrackEvent` function has been added to enable sending custom events embedded with targeting information to Application Insights. This function is meant to be used in place of the Application Insights package's standard `TrackEvent` call. + ## 2.0.0-preview.3 - Nov 8, 2024 ### Enhancements diff --git a/releaseNotes/JavaScriptProvider.md b/releaseNotes/JavaScriptProvider.md index 26d8c5a3..3a3df6d4 100644 --- a/releaseNotes/JavaScriptProvider.md +++ b/releaseNotes/JavaScriptProvider.md @@ -4,7 +4,7 @@ ## 1.1.3 - January 8, 2025 -### Bug Fix +### Bug Fixes * Fixed a bug that could trigger concurrent data refresh. [#136](https://github.com/Azure/AppConfiguration-JavaScriptProvider/pull/136) @@ -26,7 +26,7 @@ ## 1.1.2 - November 5, 2024 -### Bug Fix +### Bug Fixes * Fixed a bug that caused `ReferenceError` of optional chaining when `process` is undefined. [#104](https://github.com/Azure/AppConfiguration-JavaScriptProvider/pull/104) @@ -82,7 +82,7 @@ Get started with the [quickstart](https://learn.microsoft.com/en-us/azure/azure- ## 1.0.0-preview.1 - October 24, 2023 -### Bug fixes +### Bug Fixes - Updated the reference of `@azure/identity` to `3.3.2`, addressing [CVE-2023-36415](https://msrc.microsoft.com/update-guide/en-US/vulnerability/CVE-2023-36415) diff --git a/releaseNotes/KubernetesProvider.md b/releaseNotes/KubernetesProvider.md index 25050ad8..7ef577e2 100644 --- a/releaseNotes/KubernetesProvider.md +++ b/releaseNotes/KubernetesProvider.md @@ -14,7 +14,7 @@ * Added support for load balancing mode, which enables your workloads to distribute requests to App Configuration across all available replicas. This enhancement improves the scalability of applications that typically experience high request volumes to App Configuration, ensuring they remain within quota limits. Load balancing mode is disabled by default and can be activated by setting `loadBalancingEnabled` to `true`. [#55](https://github.com/Azure/AppConfiguration-KubernetesProvider/issues/55) * Added support for monitoring all selected key-values. The target ConfigMaps and Secrets will be refreshed if any of key-values are updated. Watching the sentinel key for refresh helps ensure data integrity of configuration changes but it's now optional. [#40](https://github.com/Azure/AppConfiguration-KubernetesProvider/issues/40) -### Bug fixes +### Bug Fixes * Fixed a bug where ConfigMaps and Secrets may be regenerated even if there is no data change. [#75](https://github.com/Azure/AppConfiguration-KubernetesProvider/issues/75) * Fixed a bug where key-values with no label are not loaded if the label filter is specified as empty string. [#76](https://github.com/Azure/AppConfiguration-KubernetesProvider/issues/76) @@ -26,7 +26,7 @@ ### Enhancements * Added support for [multi-platform images](https://docs.docker.com/build/building/multi-platform/). The Kubernetes provider supports `linux/amd` and `linux/arm64` platforms. [#892](https://github.com/Azure/AppConfiguration/issues/892) -### Bug fixes +### Bug Fixes * Fixed a bug where a feature flag could be repeatedly added to a ConfigMap if included in multiple feature flag selectors or snapshots. ## 2.0.0-preview - May 15, 2024 @@ -36,7 +36,7 @@ ## 1.3.1 - April 25, 2024 -### Bug fixes +### Bug Fixes * Fixed a regression bug in version 1.3.0 where an empty Kubernetes Secret was not created as specified by the `spec.secret.target property` when no Key Vault references were loaded. [#32](https://github.com/Azure/AppConfiguration-KubernetesProvider/issues/32) ## 1.3.0 - April 17, 2024 @@ -59,7 +59,7 @@ * Added the `auth.workloadIdentity.managedIdentityClientIdReference` property for workloadIdentity authentication. It enables the retrieval of the client ID of a user-assigned managed identity from a ConfigMap. [#812](https://github.com/Azure/AppConfiguration/issues/812) * Added support for outputting the ConfigMap data in hierarchical format by specifying the new property `configMapData.separator` if the ConfigMap is consumed as a mounted file. This feature is useful if the configuration file loader used in your application can't load keys without converting them to the hierarchical format. [#834](https://github.com/Azure/AppConfiguration/issues/834) -### Bug fixes +### Bug Fixes * Fixed a bug that may cause the Kubernetes provider to crash with an `invalid memory address or nil pointer dereference` error when a key-value pulled from App Configuration has a `null` value. [#848](https://github.com/Azure/AppConfiguration/issues/848) ## 1.0.0 - November 15, 2023 diff --git a/releaseNotes/Microsoft.Featuremanagement.md b/releaseNotes/Microsoft.Featuremanagement.md index a0ff215d..7ce1eaef 100644 --- a/releaseNotes/Microsoft.Featuremanagement.md +++ b/releaseNotes/Microsoft.Featuremanagement.md @@ -75,7 +75,7 @@ The performance of the feature flag state evaluation has been improved by up to ## 3.3.1 - May 23, 2024 -### Bug fixes +### Bug Fixes * Fixed a bug that caused the time window filter to be unusable if `AddFeatureFilter` was called.`. [#447](https://github.com/microsoft/FeatureManagement-Dotnet/issues/447) @@ -86,7 +86,7 @@ The performance of the feature flag state evaluation has been improved by up to * Added a `Recurrence` option to the `TimeWindow` filter to support recurring time window. This enables scenarios where a feature flag is activated based on a recurrence pattern, such as every day after 5 PM or every Friday. See more details [here](https://github.com/microsoft/FeatureManagement-Dotnet?tab=readme-ov-file#recurrence-pattern). ([#266](https://github.com/microsoft/FeatureManagement-Dotnet/pull/266)) * A `LoggerFactory` is no longer required when constructing built-in filters. ([#386](https://github.com/microsoft/FeatureManagement-Dotnet/pull/386)) -### Bug fixes +### Bug Fixes * Fixed a possible null-reference exception when enumerating `GetFeatureNamesAsync`. ([#438](https://github.com/microsoft/FeatureManagement-Dotnet/pull/438)) @@ -194,7 +194,7 @@ There are no breaking changes in this release. ## 3.1.1 - December 13, 2023 -### Bug Fix +### Bug Fixes * Fixed a bug where feature manager will fail to add cache entry if the shared memory cache sets `SizeLimit`. ([#325](https://github.com/microsoft/FeatureManagement-Dotnet/issues/325)) ## 3.1.0 - November 23, 2023 @@ -296,7 +296,7 @@ If all of three filters are registered: ## 2.6.1 - June 28, 2023 -### Bug fix +### Bug Fixes * Fixed an edge case for EvaluateAsync call that doesn't use context from FeatureManager. ([#244](https://github.com/microsoft/FeatureManagement-Dotnet/issues/244)) @@ -420,7 +420,7 @@ For more details read [here](https://github.com/microsoft/FeatureManagement-Dotn ## 2.5.1 - April 6, 2022 -### Bug fix +### Bug Fixes * Updated summary on `FeatureGateAttribute` to mention that it is usable on Razor pages. [#170](https://github.com/microsoft/FeatureManagement-Dotnet/pull/170) @@ -430,7 +430,7 @@ For more details read [here](https://github.com/microsoft/FeatureManagement-Dotn * Updated `FeatureGateAttribute` to support Razor pages. This attribute can be placed on Razor page handlers to control access to the page based on whether a feature flag is on or off. [#166](https://github.com/microsoft/FeatureManagement-Dotnet/pull/166) -### Bug fix +### Bug Fixes * Fixed an issue in `PercentageFilter` where a feature may occasionally be considered as on even when the filter is set to 0 percent. [#156](https://github.com/microsoft/FeatureManagement-Dotnet/pull/156) @@ -441,7 +441,7 @@ For more details read [here](https://github.com/microsoft/FeatureManagement-Dotn * Added option to throw when attempting to evaluate a missing feature. [#140](https://github.com/microsoft/FeatureManagement-Dotnet/pull/140) * `IFeatureManagementSnapshot` is now thread-safe. [#141](https://github.com/microsoft/FeatureManagement-Dotnet/pull/141) -### Bug fix +### Bug Fixes * `FilterAliasAttribute` now uses the proper parameter name in an `ArgumentNullException` if `alias` is null. @@ -451,7 +451,7 @@ For more details read [here](https://github.com/microsoft/FeatureManagement-Dotn The net5.0 framework has been added to the list of target frameworks. This change resolves dependency issues for ASP.NET Core 5.0 applications. -### Bug fix +### Bug Fixes * The license URL for these packages has been fixed. diff --git a/releaseNotes/MicrosoftAzureAppConfigurationAspNetCore.md b/releaseNotes/MicrosoftAzureAppConfigurationAspNetCore.md index eaae6049..ba0b23b9 100644 --- a/releaseNotes/MicrosoftAzureAppConfigurationAspNetCore.md +++ b/releaseNotes/MicrosoftAzureAppConfigurationAspNetCore.md @@ -132,7 +132,7 @@ * Updated `Microsoft.Extensions.Configuration.AzureAppConfiguration` reference to `2.0.0-preview-010050001-38`. See the [release notes](./MicrosoftExtensionsConfigurationAzureAppConfiguration.md) for more information on the changes. ## 2.0.0-preview-009470001-12 - August 06, 2019 -* Updated `Microsoft.Extensions.Configuration.AzureAppConfiguration` reference to `2.0.0-preview-009470001-1371` to take in a bug fix. See the [release notes](./MicrosoftExtensionsConfigurationAzureAppConfiguration.md) for more info of the fix. +* Updated `Microsoft.Extensions.Configuration.AzureAppConfiguration` reference to `2.0.0-preview-009470001-1371` to take in a Bug Fix. See the [release notes](./MicrosoftExtensionsConfigurationAzureAppConfiguration.md) for more info of the fix. ## 2.0.0-preview-009200001-7 - July, 10 2019 * Added middleware to support dynamic configuration in ASP.NET Core applications