From 548bfe2312bd7948f091c10fca686182c986030d Mon Sep 17 00:00:00 2001 From: Dawid Dylowicz Date: Wed, 8 Nov 2017 10:59:17 +0000 Subject: [PATCH] Improve documentation according to PR review --- CHANGELOG.md | 2 ++ release_guidelines.md | 7 +++++++ webpack.config.babel.js | 4 +++- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 64302d2ed6..b0f147c684 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ This project adheres to the Node [default version scheme](https://docs.npmjs.com ## [2.0.0] +In this version, we're introducting cross-device flow that allows to continue verification on mobile in order to take photos of your document and face. + **Note:** * This version is not backwards-compatible. Migration notes can be found in [MIGRATION.md](MIGRATION.md) diff --git a/release_guidelines.md b/release_guidelines.md index 395bdeb439..653ca36215 100644 --- a/release_guidelines.md +++ b/release_guidelines.md @@ -43,6 +43,7 @@ An example `` could be `2.0.0` * Check you can install your release with `npm install onfido-sdk-ui` * Create a new release on GitHub * Commit and merge the release branch into master +* After the release: [Update Sample App](#update-sample-app) ## Update JSFiddle Demo * Make sure the `dist/` folder is updated and commited (by `npm run build`) @@ -57,6 +58,12 @@ An example `` could be `2.0.0` * Follow the migration notes and update the code if necessary * Test the happy path +## Update Sample App +* https://github.com/onfido/onfido-sdk-web-sample-app +* After the release, bump Onfido SDK version in `package.json` of Sample App +* If Onfido SDK release introduced breaking changes, apply them according to migration guide +* Issue PR with mentioned changes to master + ## Outside of the release ### Deploying the release to the S3 staging for use in the cross device flow diff --git a/webpack.config.babel.js b/webpack.config.babel.js index 778d47160f..14b4dacf1b 100644 --- a/webpack.config.babel.js +++ b/webpack.config.babel.js @@ -99,7 +99,9 @@ const basePlugins = [ 'WOOPRA_DOMAIN': `${DEV_OR_STAGING ? 'dev-':''}onfido-js-sdk.com`, 'DESKTOP_SYNC_URL': CONFIG.DESKTOP_SYNC_URL, 'MOBILE_URL' : CONFIG.MOBILE_URL, - // Increment this with each release + // Increment BASE_36_VERSION with each release following Base32 notation, i.e AA -> AB + // Do it only when we introduce a breaking change between SDK and cross device client + // ref: https://en.wikipedia.org/wiki/Base32 'BASE_36_VERSION' : 'AA', })) ]