- Merge your branch into main
- Run
npm version [patch|minor|major]which will do the following:
- write new version to package.json
- create a commit with a commit message matching the version number
- create a new tag matching the version number
- Push the new commit and tags to main with
git push && git push --tags - Deploy built scripts to s3 via shipit
If your change affects how people use the project (i.e. adding or
changing arguments to a function, adding a new function, changing the
return value, etc), please ensure the documentation is also updated to
reflect this. The docs live inside the docs/ folder and are hosted
at http://shopify.github.io/js-buy-sdk.
Please update the docs in a separate PR from the code change. When the two are updated together, the diff will be huge and it will be difficult to review.
- Generate documentation using
npm run doc:buildoryarn doc:build - Update the Changelog with details about the release.
- Merge your branch into main