Release v2024‐03‐01

Prepare the release process

• Make a copy of the latest release Release-v2023-12-18 document as a new page on cardano-wallet's wiki called Release-v2023-12-18.

• Pick up the latest green commit from master and prove it's green by linking the succesful buildkite and github actions builds here.

  • commit: 241100ccca32d45afc126ae452aab4996c707300

  • buildkite

    • cardano-wallet

  • shepherd the commit through CI-2

    • Make sure the release-candidate cardano-wallet is green (link)[https://buildkite.com/cardano-foundation/cardano-wallet/builds/3832]

    • Make sure the rc-latest is green, take note of build 3835 as the artifacts source (link)[https://buildkite.com/cardano-foundation/cardano-wallet/builds/3835]

    • Make sure the docker image for rc-latest was pushed link

    • Run Linux E2E tests on rc-latest artifacts link

    • Run Windows E2E tests on rc-latest artifacts link

    • Run MacOS E2E tests on rc-latest artifacts link

    • Run Docker E2E tests on the rc-latest and node 8.7.2 (look for rc-latest in the start wallet) link

    • Run Windows unit tests on rc-latest artifacts link Done later as the unit test name was changed but the action was not updated.

    • Run benchmarks on rc-release commit link

    • Run docker-compose for Linux on rc-latest image link

Prepare the release

• Trigger a release build on CI (GitHub Actions) for this release branch and wait for the build artifacts to be published on the GitHub release page.

  export RELEASE_GIT_COMMIT=e69616ba776f4a52173ead423141d234e03d468f
  export NEW_GIT_TAG=v2024-03-01
  git tag --sign -m $NEW_GIT_TAG $NEW_GIT_TAG $RELEASE_GIT_COMMIT
  git push origin $NEW_GIT_TAG

Create the release notes

• Write release notes in the release page based on Next Release Notes

Verify release artifacts

• Verify that the documentations have been correctly exported on gh-pages

• Make a commit with redirects to the documentation for the release like this one.

 git checkout gh-pages
 git pull origin gh-pages
 cd releases
 ./make_redirects.sh vYYYY-MM-DD
 git push origin gh-pages

• Make sure the Command-Line Interface manual is up to date.

Manual ad-hoc verifications

• Execute on Linux and partially on MacOS manual scenarios on the binaries to be released. https://docs.google.com/spreadsheets/d/1fCCI9TcbS2_pTjGJfw2umMFczhYDjLux5rz-65UkEUw/edit#gid=415901212

• Verify that sensitive fields listed in Cardano/Wallet/Api/Server are still accurate and aren't missing any new ones.

  sensitive =
      [ "passphrase"
      , "old_passphrase"
      , "new_passphrase"
      , "mnemonic_sentence"
      , "mnemonic_second_factor"
      ]
  

Publication

• Once everyone has signed off (i.e. Tech lead, QA & Release manager), publish the release draft.

• Merge the (administrative) commits created for the release tag back into the master branch.

• Remember to leave this checklist in an up-to-date status for the next releaser