Skip to content

Commit

Permalink
Improve documentation according to PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
dawiddylowicz committed Nov 8, 2017
1 parent 33fcb8a commit 548bfe2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
7 changes: 7 additions & 0 deletions release_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ An example `<version>` 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`)
Expand All @@ -57,6 +58,12 @@ An example `<version>` 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
Expand Down
4 changes: 3 additions & 1 deletion webpack.config.babel.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
}))
]
Expand Down

0 comments on commit 548bfe2

Please sign in to comment.