Skip to content

chore: prepare for release 3.3.0 #305

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.

Sign up for GitHub

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 1 commit into from
Mar 11, 2020
Merged

chore: prepare for release 3.3.0 #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
os: osx
osx_image: xcode11.3
env:
- VERSION=3.2.1
- VERSION=3.3.0
install:
# install hub
- wget https://github.com/github/hub/releases/download/v2.11.2/hub-darwin-amd64-2.11.2.tgz -O /tmp/hub-darwin-amd64-2.11.2.tgz && tar -xvf /tmp/hub-darwin-amd64-2.11.2.tgz -C /usr/local/opt && ln -s /usr/local/opt/hub-darwin-amd64-2.11.2/bin/hub /usr/local/bin/hub
Expand All @@ -130,7 +130,7 @@ jobs:
os: osx
osx_image: xcode11.3
env:
- VERSION=3.2.1
- VERSION=3.3.0
install:
# install hub
- wget https://github.com/github/hub/releases/download/v2.11.2/hub-darwin-amd64-2.11.2.tgz -O /tmp/hub-darwin-amd64-2.11.2.tgz && tar -xvf /tmp/hub-darwin-amd64-2.11.2.tgz -C /usr/local/opt && ln -s /usr/local/opt/hub-darwin-amd64-2.11.2/bin/hub /usr/local/bin/hub
Expand Down
22 changes: 22 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Optimizely Swift SDK Changelog

## 3.3.0
March 11, 2020

This release includes an enhancement of SDK initialization API to enable SDK updated on cached datafile change. It also fixes known bugs.

### New Features
* Add an option for **synchronous** initialization to enable SDK immediately updated when a new datafile is cached. Unless this feature is enabled, by default, the cached datafile will be used only when the SDK re-starts in the next session. Note that this option is for **synchronous** initialization only. ([#297](https://github.com/optimizely/swift-sdk/pull/297))

```
// enable SDK update when a new datafile is cached
optimizelyClient.start(datafile: data, doUpdateConfigOnNewDatafile: true)

// by default, this feature is disabled
optimizelyClient.start(datafile: data)
```

### Bug Fixes
* When a **synchronously**-initialized SDK enables background datafile polling and its datafile was changed in the server, the new datafile is cached but SDK is not dynamically updated. ([#297](https://github.com/optimizely/swift-sdk/pull/297))
* When background datafile polling is enabled and app goes to background and comes back to foreground after some delays, datafile fetching is called multiple times back-to-back. ([#301](https://github.com/optimizely/swift-sdk/pull/301))
* NotificationCenter can cause crashes when multiple threads add/call listeners simultaneously. ([#304](https://github.com/optimizely/swift-sdk/pull/304))


## 3.2.1
January 16, 2020

Expand Down
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,28 @@ up an Optimizely X project and start using the SDK.

Please note below that _\<platform\>_ is used to represent the platform on which you are building your app. Currently, we support ```iOS``` and ```tvOS``` platforms.

#### Swift Package Manager
Add the following line to the dependencies value of your _Package.swift_:

```
dependencies: [
.package(url: "https://github.com/optimizely/swift-sdk.git",
.upToNextMinor(from: “3.3.0”))
]
```

#### CocoaPods
1. Add the following lines to the _Podfile_:<pre>
```use_frameworks!```
```pod 'OptimizelySwiftSDK', '~> 3.2.1'```
</pre>
```use_frameworks!```
```pod 'OptimizelySwiftSDK', '~> 3.3.0'```
</pre>

2. Run the following command: <pre>``` pod install ```</pre>

Further installation instructions for Cocoapods: https://guides.cocoapods.org/using/getting-started.html

#### Carthage
1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" ~> 3.2.1```</pre>
1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" ~> 3.3.0```</pre>

2. Run the following command:<pre>```carthage update```</pre>

Expand All @@ -56,15 +66,6 @@ Further installation instructions for Cocoapods: https://guides.cocoapods.org/us

Futher installation instructions for Carthage: https://github.com/Carthage/Carthage

#### Swift Package Manager
Add the following line to the dependencies value of your _Package.swift_:

```
dependencies: [
.package(url: "https://github.com/optimizely/swift-sdk.git", .upToNextMinor(from: “3.2.1”))
]
```

### Samples

A sample code for SDK initialization and experiments:
Expand Down