Release Checklist

Pre-release

• Your changes should be on a branch.
• Your changes should have unit tests.
• Lint the code with yarn lint
• Build your code with yarn build
• Run the unit tests with yarn test
• Get a full code review.
• Merge your branch into develop and push to github.

Release

• Update package.json to bump the ripple-lib version number.

• Update HISTORY.md

  • Update the version number and release date, and ensure it lists the changes since the previous release.

• Commit and push to github.

• If this is not a beta release: Merge develop into master (--ff-only) and push to github.*

• Publish the release to npm.

  • If this is a beta release, use:

    yarn publish --tag beta
    

    This allows someone else to install the package with yarn add ripple-lib@beta.

  • If this is a stable release, use:

    yarn publish
    

• Create a release on github with an appropriate tag name (the version number). Upload and include files for the browser build of ripple-lib.

• Send an email to ripple-lib-announce.

• Open a PR to update the docs if docs were modified (example).

*This is important because we have docs telling developers to use master to get the latest release.