Skip to content

Release Checklist

Jackson Mills edited this page Nov 1, 2021 · 29 revisions

Pre-release

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

Release

  • Update package.json to bump the xrpl.js 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 build/* 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.*

  • Publish the release to npm.

    • If this is a beta release, use:

      npm publish --tag beta
      

      This allows someone else to install the package with npm add xrpl@beta.

    • If this is a stable release, use:

      npm publish
      
  • Create a release on github with an appropriate tag name (the version number).

    • Upload and include files for the browser build of xrpl.js, including the pre-built and minified versions (#1310):
    • open build -> drag files to GitHub
  • Send an email to xrpl-announce.

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

Clone this wiki locally