Skip to content

Release Checklist

Gregor Mitscha-Baude edited this page Mar 9, 2023 · 9 revisions

Before:

  • Update examples in zkapp-cli
  • Update code examples and references to SnarkyJS API in the documentation
  • Update the tutorials
  • Ensure there exists documentation for the new features

Execution:

  • Bump the version in SnarkyJS
  • Make the "unreleased changes" section in the CHANGELOG.md the section for the current release
  • If this update corresponds to a network update: Rebuild SnarkyJS from the corresponding Mina source branch (currently mina/rampup), using ./scripts/update-snarkyjs-bindings.sh in the Mina repo
    • Check in the updated bindings
    • With the updated bindings, test to make sure SnarkyJS + Mina Signer generate compatible signatures for whichever network we're targeting (mainnet, testnet, etc)
  • Make a PR to main with the 3 changes above and merge it
  • Make a PR for the zkapp-CLI to bump both the SnarkyJS and CLI versions.
    • If this SnarkyJS release includes breaking changes, also bump the zkapp-cli semver appropriately to indicate a breaking change, so that the zkapp-cli's version check warning system for devs will work as intended.
    • Warning: Only merge the CLI PR once the SnarkyJS one finished and auto-published the release! Also, updating the package-lock.json files in the CLI is easiest by doing npm i in those folders, once SnarkyJS is published
  • PR for updating the SnarkyJS API Reference on the docs website
  • PR for the hand-written documentation changes
Clone this wiki locally