Skip to content

Commit

Permalink
[FSSDK-8581] chore: Prepare for 4.0.0 release (#371)
Browse files Browse the repository at this point in the history
* chore: Update AssemblyInformationalVersion

removed beta tag for NuGet

* docs: Update changelog

* docs: Test whether I have to manually link PRs

* docs: Add PR links

wwwhyy is this still something I have to do??? *coughs: AI*

* docs: Update version listed on README

This file needs to be reviewed & updates

* docs: Update version listed on README

This file needs to be reviewed & updates

* docs: Update CHANGELOG with 4.0-GA info

bring pre-release beta notes up to the GA version section

* docs: Update LICENSE copyright line

* docs: Reorder CHANGELOG entries
  • Loading branch information
mikechu-optimizely authored Jan 16, 2024
1 parent c6213a9 commit 50533a9
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 10 deletions.
70 changes: 70 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,75 @@
# Optimizely C# SDK Changelog

## 4.0.0
January 16th, 2024

### New Features

#### Advanced Audience Targeting

The 4.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting)
enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) (
[#305](https://github.com/optimizely/csharp-sdk/pull/305),
[#310](https://github.com/optimizely/csharp-sdk/pull/310),
[#311](https://github.com/optimizely/csharp-sdk/pull/311),
[#315](https://github.com/optimizely/csharp-sdk/pull/315),
[#321](https://github.com/optimizely/csharp-sdk/pull/321),
[#322](https://github.com/optimizely/csharp-sdk/pull/322),
[#323](https://github.com/optimizely/csharp-sdk/pull/323),
[#324](https://github.com/optimizely/csharp-sdk/pull/324)
).

You can use ODP, a high-performance [Customer Data Platform (CDP)]( https://www.optimizely.com/optimization-glossary/customer-data-platform/), to easily create complex
real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important
for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can
be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and
make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:
- New API added to `OptimizelyUserContext`:
- `FetchQualifiedSegments()`: this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.
- When an `OptimizelyUserContext` is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.
- New APIs added to `OptimizelyClient`:
- `SendOdpEvent()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:
- [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting)
- [Server SDK Support](https://docs.developers.optimizely.com/feature-experimentation/v1.0/docs/advanced-audience-targeting-for-server-side-sdks)
- [Initialize C# SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/initialize-sdk-csharp)
- [OptimizelyUserContext C# SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizelyusercontext-csharp)
- [Advanced Audience Targeting segment qualification methods](https://docs.developers.optimizely.com/feature-experimentation/docs/advanced-audience-targeting-segment-qualification-methods-csharp)
- [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-csharp)

#### Polling warning

Add warning to polling intervals below 30 seconds ([#365](https://github.com/optimizely/csharp-sdk/pull/365))

### Breaking Changes
- `OdpManager` in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most `OdpManager` functions will be ignored. If needed, `OdpManager` can be disabled when `OptimizelyClient` is instantiated.
- `ProjectConfigManager` interface additions + implementing class updates
- `Evaluate()` updates in `BaseCondition`

### Bug Fixes
- Return Latest Experiment When Duplicate Keys in Config enhancement

### Documentation
- Corrections to markdown files in docs directory ([#368](https://github.com/optimizely/csharp-sdk/pull/368))
- GitHub template updates ([#366](https://github.com/optimizely/csharp-sdk/pull/366))

## 3.11.4
July 26th, 2023

### Bug Fixes
- Fix Last-Modified date & time format for If-Modified-Since ([#361](https://github.com/optimizely/csharp-sdk/pull/361))

## 3.11.3
July 18th, 2023

### Bug Fixes
- Last-Modified in header not found and used to reduce polling payload ([#355](https://github.com/optimizely/csharp-sdk/pull/355)).

## 4.0.0-beta
April 28th, 2023

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2016 Optimizely
Copyright 2016-2024, Optimizely, Inc. and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion OptimizelySDK.DemoApp/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
2 changes: 1 addition & 1 deletion OptimizelySDK.Net35/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
2 changes: 1 addition & 1 deletion OptimizelySDK.Net40/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
2 changes: 1 addition & 1 deletion OptimizelySDK.NetStandard16/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
2 changes: 1 addition & 1 deletion OptimizelySDK.NetStandard20/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
2 changes: 1 addition & 1 deletion OptimizelySDK.Tests/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
2 changes: 1 addition & 1 deletion OptimizelySDK/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@
// by using the '*' as shown below:
[assembly: AssemblyVersion("4.0.0.0")]
[assembly: AssemblyFileVersion("4.0.0.0")]
[assembly: AssemblyInformationalVersion("4.0.0-beta")] // Used by Nuget.
[assembly: AssemblyInformationalVersion("4.0.0")] // Used by NuGet.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ User can provide variables using following procedure:
```
<configSections>
<section name="optlySDKConfigSection"
type="OptimizelySDK.OptimizelySDKConfigSection, OptimizelySDK, Version=3.2.0.0, Culture=neutral, PublicKeyToken=null" />
type="OptimizelySDK.OptimizelySDKConfigSection, OptimizelySDK, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null" />
</configSections>
```
2. Now add **optlySDKConfigSection** below **<configSections>**. In this section you can add and set following **HttpProjectConfigManager** and **BatchEventProcessor** variables:
Expand Down Expand Up @@ -251,4 +251,4 @@ Optimizely SDK uses third party software:

- Ruby - https://github.com/optimizely/ruby-sdk

- Swift - https://github.com/optimizely/swift-sdk
- Swift - https://github.com/optimizely/swift-sdk

0 comments on commit 50533a9

Please sign in to comment.