-
Notifications
You must be signed in to change notification settings - Fork 83
Add release notes for the beta version. #82
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5846b0c
Add release notes for the beta version.
14c2580
Add MD extension to changelog.
41080e8
Re-format the changelog.
c074add
Move getEnabledFeatures to its own bullet.
7c0522c
Fix indentation.
10cf380
Include refreshed encrypted BS keys for tests on Travis.
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| ## 2.0.0-beta1 | ||
| April 15th, 2018 | ||
|
|
||
| This major release of the Optimizely SDK introduces APIs for Feature Management. It also introduces some breaking changes listed below. | ||
|
|
||
| ### New Features | ||
| * Introduces the `isFeatureEnabled` API to determine whether to show a feature to a user or not. | ||
| ``` | ||
| var enabled = optimizelyClient.isFeatureEnabled('my_feature_key', 'user_1', userAttributes); | ||
| ``` | ||
|
|
||
| * You can also get all the enabled features for the user by calling: | ||
| ``` | ||
| var enabledFeatures = optimizelyClient.getEnabledFeatures('user_1', userAttributes); | ||
| ``` | ||
|
|
||
| * Introduces Feature Variables to configure or parameterize your feature. There are four variable types: `Integer`, `String`, `Double`, `Boolean`. | ||
| ``` | ||
| var stringVariable = optimizelyClient.getFeatureVariableString('my_feature_key', 'string_variable_key', 'user_1'); | ||
| var integerVariable = optimizelyClient.getFeatureVariableInteger('my_feature_key', 'integer_variable_key', 'user_1'); | ||
| var doubleVariable = optimizelyClient.getFeatureVariableDouble('my_feature_key', 'double_variable_key', 'user_1'); | ||
| var booleanVariable = optimizelyClient.getFeatureVariableBoolean('my_feature_key', 'boolean_variable_key', 'user_1'); | ||
| ``` | ||
|
|
||
| ### Breaking changes | ||
| * 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. | ||
| ``` | ||
| var eventTags = { | ||
| 'revenue': 1200 | ||
| }; | ||
|
|
||
| optimizelyClient.track('event_key', 'user_id', userAttributes, eventTags); | ||
| ``` | ||
| * The package name has changed from `optimizely-client-sdk` to `optimizely-sdk` as we have consolidated both Node and JavaScript SDKs into one. | ||
|
|
||
| ## 1.6.0 | ||
|
|
||
| * Bump optimizely-server-sdk to version 1.5.0, which includes: | ||
| - Implemented IP anonymization. | ||
| - Implemented bucketing IDs. | ||
| - Implemented notification listeners. | ||
|
|
||
| ## 1.5.1 | ||
| * Bump optimizely-server-sdk to version 1.4.2, which includes: | ||
| - Bug fix to filter out undefined values in attributes and event tags | ||
| - Remove a duplicated test | ||
|
|
||
| ## 1.5.0 | ||
| * Bump optimizely-server-sdk to version 1.4.0, which includes: | ||
| - Add support for numeric metrics. | ||
| - Add getForcedVariation and setForcedVariation methods for client-side variation setting | ||
| - Bug fix for filtering out null attribute and event tag values | ||
|
|
||
| ## 1.4.3 | ||
| * Default skipJSONValidation to true | ||
| * Bump optimizely-server-sdk to version 1.3.3, which includes: | ||
| - Removed JSON Schema Validator from Optimizely constructor | ||
| - Updated SDK to use new event endpoint | ||
| - Minor bug fixes | ||
|
|
||
| ## 1.4.2 | ||
| * Minor performance improvements. | ||
|
|
||
| ## 1.4.1 | ||
| * Switched to karma/browserstack for cross-browser testing | ||
| * Removed es6-promise | ||
| * Bump optimizely-server-sdk to version 1.3.1, which includes: | ||
| - Minor performance improvements. | ||
|
|
||
| ## 1.4.0 | ||
| * Reduce lodash footprint. | ||
| * Bump optimizely-server-sdk to version 1.3.0, which includes: | ||
| - Introduced user profile service. | ||
| - Minor performance and readibility improvements. | ||
|
|
||
| ## 1.3.5 | ||
| * Bump optimizely-server-sdk to version 1.2.3, which includes: | ||
| - Switched to json-schema library which has a smaller footprint. | ||
| - Refactored order of bucketing logic. | ||
| - Refactor lodash dependencies. | ||
| - Fixed error on validation for objects with undefined values for attributes. | ||
|
|
||
| ## 1.3.4 | ||
| * Bump optimizely-server-sdk to version 1.2.2, which includes: | ||
| - Use the 'name' field for tracking event tags instead of 'id'. | ||
|
|
||
| ## 1.3.3 | ||
| * Include index.js in package.json files to make sure it gets published regardless of node environment. | ||
|
|
||
| ## 1.3.2 | ||
| * Bump to 1.3.2 to re-publish to npm | ||
|
|
||
| ## 1.3.1 | ||
| * Bump optimizely-server-sdk to version 1.2.1, which includes: | ||
| - Gracefully handle empty traffic allocation ranges. | ||
|
|
||
| ## 1.3.0 | ||
| * Bump optimizely-server-sdk to version 1.2.0, which includes: | ||
| - Introduce support for event tags. | ||
| - Add optional eventTags argument to track method signature. | ||
| - Removed optional eventValue argument from track method signature. | ||
| - Removed optional sessionId argument from activate and track method signatures. | ||
| - Allow log level config on createInstance method. | ||
|
|
||
| ## 1.2.2 | ||
| * Remove .npmignore to consolidate with .gitignore. | ||
| * Add dist and lib directories to "files" in package.json. | ||
|
|
||
| ## 1.2.1 | ||
| * Fix webpack build error. | ||
|
|
||
| ## 1.2.0 | ||
| * Bump optimizely-server-sdk to version 1.1.0, which includes: | ||
| - Add optional sessionId argument to activate and track method signatures. | ||
| - Add sessionId and revision to event ticket. | ||
| - Add 'Launched' status where user gets bucketed but event is not sent to Optimizely. | ||
|
|
||
| ## 1.1.1 | ||
| * Bump to optimizely-server-sdk to version 1.0.1, which includes: | ||
| - Fix bug so conversion event is not sent if user is not bucketed into any experiment. | ||
| - Bump bluebird version from 3.3.5 to 3.4.6. | ||
| - Update event endpoint from p13nlog.dz.optimizely to logx.optimizely. | ||
|
|
||
| ## 1.1.0 | ||
| * Add global variable name export for use in non-CommonJS environments | ||
| * Remove redundant lodash core dependency to reduce bundle bloat | ||
|
|
||
| ## 1.0.0 | ||
| * Introduce support for Full Stack projects in Optimizely X with no breaking changes from previous version. | ||
| * Introduce more graceful exception handling in instantiation and core methods. | ||
| * Update whitelisting to take precedence over audience condition evaluation. | ||
| * Fix bug activating/tracking with attributes not in the datafile. | ||
|
|
||
| ## 0.1.4 | ||
| * Add functionality for New Optimizely endpoint. | ||
|
|
||
| ## 0.1.3 | ||
| * Add environment detection to event builder so it can distinguish between events sent from node or the browser. | ||
|
|
||
| ## 0.1.2 | ||
| * Add CORS param to prevent browsers from logging cors errors in the console when dispatching events. | ||
|
|
||
| ## 0.1.1 | ||
| * Remove percentageIncluded field from JSON schema, which is not needed. | ||
|
|
||
| ## 0.1.0 | ||
| * Beta release of the Javascript SDK for our Optimizely testing solution | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discuss return type since it's not clear immediately it will be a list. Hopefully we can also add an HTML link to dev docs or knowledge base in the future.