Release checklist

Preparing the release

• Update Changelog with all relevant information for upcoming release.

• Bump version in all packages.

  • command-line/package.yaml
  • core/package.yaml
  • jsbits/package.yaml
  • jsapi/cardano-addresses-jsapi.cabal

• Regenerate .cabal files from package.yaml files.

  git ls-files '**/package.yaml' | xargs -n1 hpack --force --hash

ℹ️ hpack

• Bump version in jsapi/package.json and jsapi/package-lock.json.

• Once changelog and version updates are merged, add new tag (same as newly bumped version) and push it, e.g.:

  $ git checkout master
  $ git pull
  $ git tag --sign -m "3.1.1" 3.1.1
  $ git push origin 3.1.1

• Make sure all CI workflows pass for pushed tag.

• Confirm that the NPM Package and TypeScript documentation are up to date (they should have been published by CI for the tag). Note that unlike cardano-launcher, NPM upload is triggered by tag push rather than publishing the GitHub release.

• Create release notes based on Changelog. Manually attach binaries to the release for:

• Windows

• Linux

• Smoke test Windows and Linux binaries on respective operating systems.

  • make sure help is rendered correctly
  • make sure version is correct
  • few basic operations, e.g.:

cardano-address
cardano-address version
cardano-address recovery-phrase generate --size 15 > phrase.prv
cardano-address key from-recovery-phrase Shelley < phrase.prv > root.xsk
cardano-address key child 1852H/1815H/0H/0/0 < root.xsk | cardano-address key public --with-chain-code

Publication

• Once everyone has signed off (i.e. Tech lead, QA & Release manager), publish the release draft.
• Make sure that Changelog includes date for the latest release.