Skip to content

Release Checklist

Elliot Lee edited this page Sep 28, 2018 · 29 revisions

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.
    • Use shasum -a 256 * to get the SHA-256 checksums. Add these to the file.
  • Commit and push to github.
  • If this is not a beta release: Merge develop into master (--ff-only) and push to github.*
  • Ensure that the build/* files are what you want to publish to npm (you may wish to delete older versions).
  • Publish the release to npm with 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.

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