Release v2024 09 29

Prepare the release process

• Made a copy of the latest release Release-v2024-09-26 documented as a new page on cardano-wallet's wiki called Release-v2024-09-29.

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

  • master branching point: https://github.com/cardano-foundation/cardano-wallet/commit/7a8b49ab49c40041c5be42a02d28417995dc93c3

  • release commit: https://github.com/cardano-foundation/cardano-wallet/commit/b44176d25d8d417f06aa2640513ace2d65b91b00

  • relelase pipeline build: https://buildkite.com/cardano-foundation/cardano-wallet-release/builds/523

  • main pipeline build: https://buildkite.com/cardano-foundation/cardano-wallet/builds/7674

  • Check Windows E2E tests on release commit artifacts, note that the github action code is taken from master

    • https://github.com/cardano-foundation/cardano-wallet/actions/runs/11095753628
      • E2E failed without funds:
        • https://github.com/cardano-foundation/cardano-wallet/actions/runs/11095753628/job/30824774649
        • there is a ticket to fund the wallet: https://cardanofoundation.atlassian.net/browse/ADP-3465
      • we had success on a previous run:
        • https://github.com/cardano-foundation/cardano-wallet/actions/runs/11038573982
        • nothing has changed in the codebase, so we can consider this green

  • Check Windows unit tests on release commit artifacts

    • https://github.com/cardano-foundation/cardano-wallet/actions/runs/11095753629

  • Check for performance regressions on the release commit artifacts:

    • https://buildkite.com/organizations/cardano-foundation/pipelines/cardano-wallet/builds/7674/jobs/01923f5f-8d2c-49f3-85b4-3e5bf0fbdfed/artifacts/01923f91-914f-4283-9b56-3678643a48c9
    • okish
    • a ticket is opened to make sure this bechmarks are run when the restorations are not
      • https://cardanofoundation.atlassian.net/browse/ADP-3466

  • Unblock the release block on relelase pipeline build: https://buildkite.com/cardano-foundation/cardano-wallet-release/builds/523

Update the release page

• Fix the release note on the draft release automatically created by the release pipeline https://github.com/cardano-foundation/cardano-wallet/releases/tag/v2024-09-29

Check out the docker image is on the docker hub

• link: https://hub.docker.com/r/cardanofoundation/cardano-wallet/tags
  • The tag was not pushed.
    • A ticket is opened to fix this: https://cardanofoundation.atlassian.net/browse/ADP-3467
  • I have pushed the tag by hand by
    • Copying the image content into my box from https://buildkite.com/organizations/cardano-foundation/pipelines/cardano-wallet/builds/7674/jobs/01923f5f-8d59-46ff-b529-a594a3ae9d7e/artifacts/01923f6d-ca17-4fed-b5eb-9c32803ec69c
    • Getting the credentials to dockerhub
      • https://start.1password.com/open/i?a=TYQQQLKUDBAFVHQ4P7XKFCUVYM&v=fhipthmhnufti4q2kky6d7336u&i=mbezvxuchiz3ehp3tvef766sca&h=cardanofoundation.1password.com
    • Copying them in ~/.docker/config.json
    • Pushing the image by hand

      docker login
      docker load < Downloads/cardano-wallet-v2024-09-29-docker-image.tgz
      docker push cardanofoundation/cardano-wallet:2024.9.29
      docker tag cardanofoundation/cardano-wallet:2024.9.29 cardanofoundation/cardano-wallet:latest
      docker push cardanofoundation/cardano-wallet:latest

• Report the link in the release notes
  • https://hub.docker.com/layers/cardanofoundation/cardano-wallet/2024.9.29/images/sha256-968bc6768e5fa87ecad770fee8546f4c6c9adfa1aa26cdffb6706cdc34794ae1?context=explore

Check out the bump.sh portal has the new release

• This has failed (again). The documentation was uploaded but the version is wrong. The reason could be no API changes aside the version bump ? https://bump.sh/hal-cardano-foundation/doc/cardano-wallet-backend A ticket to fix this is already opened https://cardanofoundation.atlassian.net/browse/ADP-3425

Fix redirect links in the documentation

• Make a commit with redirects to the documentation for the release like bash export NEW_GIT_TAG=v2024-09-29 git checkout gh-pages git pull origin gh-pages cd releases ./make_redirects.sh $NEW_GIT_TAG git push origin gh-pages A ticket is opened to automate this step https://cardanofoundation.atlassian.net/browse/ADP-3428

Check sensitive fields in the API

• 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 two engineers have signed off, publish the release draft.

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

• Check out the documentation has been published by the github action https://github.com/cardano-foundation/cardano-wallet/actions/runs/11099973143/job/30835027162

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