Skip to content

Update CHANGELOG.MD #443

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 5 commits into from
Apr 8, 2020
Merged

Update CHANGELOG.MD #443

merged 5 commits into from
Apr 8, 2020

Conversation

yavorona
Copy link
Contributor

@yavorona yavorona commented Apr 6, 2020

Hey @mjc1283,

please take a look at this update to CHANGELOG.MD below. Thanks!

Summary

Changed functionality of JSON schema validation by removing skipJSONValidation entirely.
Now user will need to import jsonSchemaValidator from @optimizely/optimizely-sdk/lib/utils/json_schema_validator and pass it to createInstance when validation is desired.

Test plan

Issues

pr #442 OASIS-6102

@coveralls
Copy link

coveralls commented Apr 6, 2020

Coverage Status

Coverage remained the same at 97.243% when pulling a596cf5 on pnguen-pr442 into b1436b6 on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.223% when pulling f0d256f on pnguen-pr442 into 1b71750 on master.

### New Features

- Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442))
- Previosly, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated
Copy link
Contributor

Choose a reason for hiding this comment

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

typo. Previously

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

@@ -12,6 +12,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Breaking Changes:
- Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417))

### New Features

- Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442))
Copy link
Contributor

Choose a reason for hiding this comment

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

nit. Put period at end of each sentence.


- Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442))
- Previosly, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated
- Now, `skipJSONValidation` has been removed entirely from all three entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below:
Copy link
Contributor

Choose a reason for hiding this comment

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

just say all entry points

@yavorona yavorona removed their assignment Apr 7, 2020
@mikeproeng37 mikeproeng37 requested a review from mjc1283 April 7, 2020 22:36
Copy link
Contributor

@mjc1283 mjc1283 left a comment

Choose a reason for hiding this comment

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

LGTM @yavorona! Just one thing.

@@ -12,6 +12,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Breaking Changes:
- Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417))

### New Features
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's put this under ### Breaking Changes, not ### New Features.

@yavorona
Copy link
Contributor Author

yavorona commented Apr 8, 2020

@mjc1283 Done!

@yavorona yavorona removed their assignment Apr 8, 2020
Copy link
Contributor

@aliabbasrizvi aliabbasrizvi left a comment

Choose a reason for hiding this comment

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

I'd leave it to @mjc1283 to take a look and approve.

@mjc1283 mjc1283 merged commit fd18bfe into master Apr 8, 2020
@mjc1283 mjc1283 deleted the pnguen-pr442 branch April 8, 2020 23:05
jasonkarns added a commit to github/optimizely-javascript-sdk that referenced this pull request May 12, 2020
* v4:
  test suite doesn't pass cleanly
  prepare already runs build
  v4.0.0-github.0
  Ignore package tarballs
  Resume building non-minified ES entrypoint
  revert to master
  Expose an ESM-FULL bundle which includes optimizely deps
  Standardize ESM bundle
  Generate both min and non-min esm output
  exports option for es output is redundant. auto is best
  Use rollup --config- options for specifying bundles
  Build-all by default
  build various bundles using --config-* param
  chore: Prepare for 4.0.0 release (optimizely#468)
  fix: Removed React Native client engine temporarily (optimizely#466)
  chore: Prepare for 4.0.0-rc.2 release (optimizely#465)
  chore: Add source maps to build output (optimizely#464)
  fix(project config): Don't mutate the datafile object (optimizely#462)
  chore: Prepare for 4.0.0-rc.1 release (optimizely#461)
  chore: Prepare for js-sdk-datafile-manager 0.5.0 release (optimizely#460)
  chore(datafile manager): Remove react native datafile manager entry from package.json (optimizely#459)
  fix(datafile manager): Node datafile requests use gzip,deflate compression (optimizely#456)
  docs(datafile manager): Removed manual dependency installation requirement from docs (optimizely#457)
  chore(datafile manager): Added async storage as dev dependency (optimizely#455)
  refactor: Added a separate bundle for Json Schema Validator (optimizely#454)
  refactor: Convert lib/utils to ES module (Part 2/2) (optimizely#452)
  refactor: Convert lib/core to ES module (Part 2/2) (optimizely#450)
  chore(datafile manager): Update years in header comments (optimizely#453)
  refactor: Convert lib/core to ES module (Part 1/2) (optimizely#449)
  refactor: Convert lib/utils to ES module (Part 1/2) (optimizely#451)
  refactor: Convert lib/optimizely/* and lib/tests/* to ES module (optimizely#448)
  refactor: Convert lib/plugins from CJS to ES module (optimizely#427)
  chore: Update js-sdk-utils to 0.2.0 (optimizely#447)
  refactor: Convert entry points to es module and create minified bundles (optimizely#445)
  chore: Update CHANGELOG.MD for jsonSchemaValidator change (optimizely#443)
  Change functionality of JSON schema validation by removing skipJSONValidation entirely. Now a user needs to import jsonSchemaValidator from @optimizely/optimizely-sdk/lib/utils/json_schema_validator and pass it to createInstance when validation is desired. (optimizely#442)
  chore(datafile manager): Lint and formatting fixes for datafile manager tests (optimizely#441)
  [OASIS-6102]: changed functionality of the JSON schema validator module (optimizely#438)
  chore(datafile manager): Fix ESLint warnings & errors, apply Prettier formatting (optimizely#440)
  fix (datafile-manager): Fix boolean types, remove StaticDatafileManager, update READMe, add eslint + prettier (optimizely#436)
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.

4 participants