Skip to content

Release Checklist

Jason edited this page Nov 22, 2022 · 9 revisions

Before:

  • Update examples in zkapp-cli
  • Update examples in the documentation
  • Update the tutorials
  • Ensure there exists documentation for the new features
  • Test to make sure SnarkyJS+zkapp-cli is compatible with whichever network we're targeting (mainnet, testnet, etc)
  • Update SnarkyJS API Reference on the docs website
  • Test to make sure SnarkyJS + Mina Signer generate compatible signatures for whichever network we're targeting (mainnet, testnet, etc)

Execution:

  • Bump the version in snarkyjs (If this includes breaking changes, also bump the zkapp-cli to indicate a breaking change as well, so that its version check warning system for devs will work as intended.)
  • Make the "unreleased changes" section in the CHANGELOG.md the section for the current release
  • Make a PR to main
  • Make a PR for the zkapp-CLI to bump both the snarkyjs and CLI versions
  • Merge those PRs. Warning: Only merge the CLI PR once the snarkyjs one finished and auto-published the release!
  • PR for the automatic API documentation changes
  • PR for the hand-written documentation changes
  • PR for updating the SnarkyJS API Reference on the docs website

Clone this wiki locally