Release v2024 08 11

Prepare the release process

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

• Check for performance regressions on the branch commit artifacts . This was don by hand by running a script that is going to be merged next week

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

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

  • release pipeline master commit: https://github.com/cardano-foundation/cardano-wallet/commit/e287dcd82e868147ff495145c3b928e7f7b7911d

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

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

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

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

  • Check Windows unit tests on branch commit artifacts

    • https://github.com/cardano-foundation/cardano-wallet/actions/runs/10341914001
    • we have a failure in the windows unit tests, but it is not related to the release artifacts It seems to be related to the windows environment, as the same test passes on linux and macos. Also the problem is the node crashing, not the wallet. The TLS issue in Windows unit tests is a flaky one we didn't manage to fix yet.

Prepare the release

• Trigger a release build on CI (GitHub Actions) for this release branch. Enforce the following in cardano-wallet repo:

  export RELEASE_GIT_COMMIT=ece92a26f37cf0bd2a8ce0e8e93c91a0387957a2
  export NEW_GIT_TAG=v2024-08-11
  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: no structural changes in the API since the last release.

Update the release page

• Write release notes in the draft release invoked by Prepare the release tag push. Do not create your own drat release, it should be automatically created already. release page

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

  • Linux (linux64 artifact)
  • Windows (win64 artifact)
  • MacOS-intel (macos-intel artifact)
  • MacOS-arm64 (macos-silicon artifact)
  • docker (docker artifact)

  If there is no artifact in the buidkite build:

  $ docker pull cardanofoundation/cardano-wallet:2024.7.27
  $ docker image ls
  REPOSITORY                         TAG           IMAGE ID       CREATED        SIZE
  cardanofoundation/cardano-wallet   2024.8.11     af5291949f8a   54 years ago   1.15GB
  $ docker save af5291949f8a | gzip > cardano-wallet-v2024-7-27-docker.tar.gz

Verify release artifacts

• Verify that the documentations have been correctly exported on https://github.com/cardano-foundation/cardano-wallet/commit/ece92a26f37cf0bd2a8ce0e8e93c91a0387957a2

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

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

• 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