Release v2024 11 18

Prepare the release process

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

• 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/18bd2083b2360c400668a6f14050973d9881d93f

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

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

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

  • 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/11896949399/job/33150049469
      • E2E failed without funds:
        • https://github.com/cardano-foundation/cardano-wallet/actions/runs/11896949399/job/33150049469#step:15:1091
        • there is a ticket to fund the wallet: https://cardanofoundation.atlassian.net/browse/ADP-3465
      • The crucial part is that the wallet is working on windows. The failure is due to the lack of funds. I consider this OK

  • Check Windows unit tests on release commit artifacts

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

  • Check for performance regressions on the release commit artifacts:

    • https://buildkite.com/organizations/cardano-foundation/pipelines/cardano-wallet/builds/8167/jobs/0193400d-8b23-42f7-b8b4-1356c5ca292f/artifacts/01934038-355c-4e56-b35e-d996fd2b2c7a
    • 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/563

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

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/8167/jobs/0193400d-8b50-421e-91db-b142e994225d/artifacts/0193401c-a6a2-4ce5-81ba-2c38dc01c90e
    • 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-11-18-docker-image.tgz
      docker push cardanofoundation/cardano-wallet:2024.11.18
      docker tag cardanofoundation/cardano-wallet:2024.11.18 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.11.5/images/sha256-90f0b439a0ec36ac09ea389f7134180697245523487b3ed6b65676233b061718?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 git clone [email protected]:cardano-foundation/cardano-wallet.git cd cardano-wallet export NEW_GIT_TAG=v2024-11-18 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/11912789791

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