Release v2024‐03‐27

Prepare the release process

• Make a copy of the latest release Release-v2024-03-01 document as a new page on cardano-wallet's wiki called Release-v2024-03-27.

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

  • github commit:

    • 1ddbb9e989c5d3941ab136effbc685b2b678c743

  • buildkite pipeline for CI-1:

    • green build

• shepherd the commit through CI-2

  • Make sure the release-candidate cardano-wallet is green

    • release candidate

  • Take node of the release commit

    • 08ab303b0e111ba8a96ab3d2634adcee230766e4

  • Make sure the rc-latest is green, take note of build 4196 as the artifacts source in the next steps

    • rc latest

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

    • docker

  • Check Linux E2E tests on rc-latest artifacts are green, note that the github action code is taken from master but run against rc-latest, look into the setup steps to see the build number

    • linux-E2E

  • Check Windows E2E tests on rc-latest artifacts, note that the github action code is taken from master but run against rc-latest, look into the setup steps to see the build number

    • windows-E2E

  • Check MacOS E2E tests on rc-latest artifacts, note that the github action code is taken from master but run against rc-latest, look into the setup steps to see the build number

    • macos-E2E

  • Check Docker E2E tests on the rc-latest and node 8.9.1, look for rc-latest in the start node and wallet step

    • docker-E2E

  • Check Windows unit tests on rc-latest artifacts

    • windows-unit

  • Check benchmarks on rc-release commit

    • benchmarks

  • Check docker-compose for Linux on rc-latest image, look for the rc-latest in check docker-compose step

    • docker-compose

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=08ab303b0e111ba8a96ab3d2634adcee230766e4
  export NEW_GIT_TAG=v2024-03-27
  git tag --sign -m $NEW_GIT_TAG $NEW_GIT_TAG $RELEASE_GIT_COMMIT
  git push origin $NEW_GIT_TAG

Update the release page

• Write release notes in the release page

• Add the relevant artifacts to the release page from the 4196 buldkite build build

  • Linux
  • Windows
  • MacOS-intel
  • MacOS-arm64

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, (not sure the value or correctness here) this one.

  git checkout gh-pages
  git pull origin gh-pages
  cd releases
  ./make_redirects.sh $NEW_GIT_TAG
  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.

• 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