Release v2024‐05‐05

Prepare the release process

• Made a copy of the latest release Release-v2024-03-27 documented as a new page on cardano-wallet's wiki called Release-v2024-05-05.

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

  • github commit:

    • c69e05fc83a2bac94945fa2482ea4ae0bbd86f70 (corresponds to release-candidate/v2024-05-05)

  • buildkite pipeline for CI-1:

    • green build (note: this is a build of a commit on master)

• shepherd the commit through CI-2

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

    • release candidate (note: this is a build of a commit on branch release-candidate/v2024-05-05 that is not on master)

  • Take note of the release commit

    • 85c53a2f8c6cb10d2d44ab045b3c5e4fb7155e7a

  • Take note of the build that produced the testable release artifacts:

    • Build number 4796
    • Note that this build is an rc-latest build against the release commit 85c53a2f8c6cb10d2d44ab045b3c5e4fb7155e7a.

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

    • rc-latest-2024-05-05

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

    • docker

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

    • linux-E2E
    • NOTE: there was one failure that corresponds to a known flaky test:
      • https://github.com/cardano-foundation/cardano-wallet/actions/runs/8962207134/job/24610757051#step:12:926
    • This flaky test was subsequently fixed in https://github.com/cardano-foundation/cardano-wallet/pull/4578/files, and this PR did not materially change the source code for any releasable artifact.

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

    • windows-E2E
    • NOTE: there was one failure that corresponds to a known flaky test:
      • https://github.com/cardano-foundation/cardano-wallet/actions/runs/8961097787/job/24608343345#step:15:851
    • This flaky test was subsequently fixed in https://github.com/cardano-foundation/cardano-wallet/pull/4578/files, and this PR did not materially change the source code for any releasable artifact.

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

    • macos-E2E

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

    • docker-E2E

  • Check Windows unit tests on rc-latest-2024-05-05 artifacts

    • windows-unit

  • Check benchmarks on rc-latest-2024-05-05 commit

    • benchmarks

Prepare the release

• Trigger a release build on CI (GitHub Actions) for this release branch.

  export RELEASE_GIT_COMMIT=85c53a2f8c6cb10d2d44ab045b3c5e4fb7155e7a
  export NEW_GIT_TAG=v2024-05-05
  git tag --sign -m $NEW_GIT_TAG $NEW_GIT_TAG $RELEASE_GIT_COMMIT
  git push origin $NEW_GIT_TAG

Hand generate the API change record

We use bump.sh to generate a record of all API changes between the last release and this release. This is the result:

• https://bump.sh/paolino/doc/cardano-wallet/changes/038fe515

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 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