Skip to content

(chore): Prepare for 3.0.0 release #217

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 4 commits into from
Feb 13, 2019
Merged

(chore): Prepare for 3.0.0 release #217

merged 4 commits into from
Feb 13, 2019

Conversation

mjc1283
Copy link
Contributor

@mjc1283 mjc1283 commented Feb 13, 2019

Summary

Prepare for 3.0.0 release.

  • Add items to CHANGELOG.md
  • Update version in package.json and enums.NODE_CLIENT_VERSION

@mjc1283 mjc1283 requested a review from nchilada February 13, 2019 19:53
@@ -7,61 +7,48 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [Unreleased]
Changes that have landed but are not yet released.

## [3.0.0-rc2] - November 16, 2018
## 3.0.0 - February 13, 2019
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps [3.0.0] for consistency sake?

- Drops `window.optimizelyClient` from the bundled build.

### Bug Fixes:
- Experiments and features can no longer activate when a negatively targeted attribute has a missing, null, or malformed value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we have links to PRs as we were doing previously?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We dropped them because it's difficult to attribute some of these items to a single PR. I suppose we could link to any PR that contributed to an item, but I'm not sure how useful that would be. @nchilada thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we were some inconsistent on this front... I did omit PR links in the centralized draft of the release notes, primarily for logistical reasons, but also because some changes couldn't be described by a single PR.

I'd say SDK releasers are free to add links, but they're not easy to determine for all changes, and I personally am not gonna require them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I'll add links to relevant PRs for top-level items.

- Drops `window.optimizelyClient` from the bundled build.

### Bug Fixes:
- Experiments and features can no longer activate when a negatively targeted attribute has a missing, null, or malformed value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we were some inconsistent on this front... I did omit PR links in the centralized draft of the release notes, primarily for logistical reasons, but also because some changes couldn't be described by a single PR.

I'd say SDK releasers are free to add links, but they're not easy to determine for all changes, and I personally am not gonna require them.

Copy link
Contributor

@mikeproeng37 mikeproeng37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

### Breaking Changes:

- Previously, notification listeners were only given string-valued user attributes because only strings could be passed into various method calls. That is no longer the case. You may pass non-string attribute values, and if you do, you must update your notification listeners to be able to receive whatever values you pass in ([#174](https://github.com/optimizely/javascript-sdk/pull/174), [#204](https://github.com/optimizely/javascript-sdk/pull/204)).
- Drops `window.optimizelyClient` from the bundled build ([#189](https://github.com/optimizely/javascript-sdk/pull/189)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit, for convenience, can we say that you should use window.optimizelySdk instead?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh yeah, that'd make sense. I had no idea!

Copy link
Contributor

@nchilada nchilada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yasss, this looks great. Thanks @mjc1283!

### Breaking Changes:

- Previously, notification listeners were only given string-valued user attributes because only strings could be passed into various method calls. That is no longer the case. You may pass non-string attribute values, and if you do, you must update your notification listeners to be able to receive whatever values you pass in ([#174](https://github.com/optimizely/javascript-sdk/pull/174), [#204](https://github.com/optimizely/javascript-sdk/pull/204)).
- Drops `window.optimizelyClient` from the bundled build ([#189](https://github.com/optimizely/javascript-sdk/pull/189)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh yeah, that'd make sense. I had no idea!

@coveralls
Copy link

coveralls commented Feb 13, 2019

Coverage Status

Coverage remained the same at 97.582% when pulling 8657bc5 on mcarroll/release-3.0.0 into 87402da on master.

@mjc1283 mjc1283 merged commit aa11fdb into master Feb 13, 2019
@mjc1283 mjc1283 deleted the mcarroll/release-3.0.0 branch February 13, 2019 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants