Skip to content

Commit cdb8d48

Browse files
authored
Add release notes for the 2.0 beta. (#96)
1 parent ffa1944 commit cdb8d48

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

CHANGELOG renamed to CHANGELOG.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,42 @@
1+
## 2.0.0.beta1
2+
March 29th, 2018
3+
4+
This major release of the Optimizely SDK introduces APIs for Feature Management. It also introduces some breaking changes listed below.
5+
6+
### New Features
7+
* Introduces the `is_feature_enabled` API to determine whether to show a feature to a user or not.
8+
```
9+
enabled = optimizely_client.is_feature_enabled('my_feature_key', 'user_1', user_attributes)
10+
```
11+
12+
* You can also get all the enabled features for the user by calling the following method which returns a list of strings representing the feature keys:
13+
```
14+
enabled_features = optimizely_client.get_enabled_features('user_1', user_attributes)
15+
```
16+
17+
* Introduces Feature Variables to configure or parameterize your feature. There are four variable types: `Integer`, `String`, `Double`, `Boolean`.
18+
```
19+
string_variable = optimizely_client.get_feature_variable_string('my_feature_key', 'string_variable_key', 'user_1')
20+
integer_variable = optimizely_client.get_feature_variable_integer('my_feature_key', 'integer_variable_key', 'user_1')
21+
double_variable = optimizely_client.get_feature_variable_double('my_feature_key', 'double_variable_key', 'user_1')
22+
boolean_variable = optimizely_client.get_feature_variable_boolean('my_feature_key', 'boolean_variable_key', 'user_1')
23+
```
24+
25+
### Breaking changes
26+
* The `track` API with revenue value as a stand-alone parameter has been removed. The revenue value should be passed in as an entry of the event tags map. The key for the revenue tag is `revenue` and will be treated by Optimizely as the key for analyzing revenue data in results.
27+
```
28+
event_tags = {
29+
'revenue'=> 1200
30+
}
31+
32+
optimizely_client.track('event_key', 'user_id', user_attributes, event_tags)
33+
```
34+
135
## 1.5.0
236
December 13, 2017
337

438
* Implemented IP anonymization.
5-
* Implemented bucketing IDs.
39+
* Implemented bucketing IDs.
640
* Implemented Notification Listeners.
741
-------------------------------------------------------------------------------
842
## 1.4.0
@@ -18,7 +52,7 @@ event_tags = {
1852
optimizely_client.track(event_key, user_id, attributes, event_tags)
1953
```
2054

21-
* Introduce Forced Variation - This allows you to force users into variations programmatically in real time for QA purposes without requiring datafile downloads from the network.
55+
* Introduce Forced Variation - This allows you to force users into variations programmatically in real time for QA purposes without requiring datafile downloads from the network.
2256
```
2357
result = optimizely_client.set_forced_variation(experiment_key, user_id, forced_variation_key)
2458
```

0 commit comments

Comments
 (0)