Release v2024‐07‐07

Prepare the release process

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

• 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: #286

  • release pipeline master commit: 8aaa5512e735a77c07ffcbf8e54e30399788f108

  • main pipeline build: #5952

  • main pipeline branch commit: 29e3aef45a58fff1aa1ca626b51395e03a0a8867

  • 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/9830370450

  • Check Windows unit tests on branch commit artifacts

    • https://github.com/cardano-foundation/cardano-wallet/actions/runs/9830370450
    • 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.

• Check for performance degradation against https://buildkite.com/cardano-foundation/cardano-wallet-nightly/builds/396

Prepare the release

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

  export RELEASE_GIT_COMMIT=29e3aef45a58fff1aa1ca626b51395e03a0a8867
  export NEW_GIT_TAG=v2024-07-07
  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/b3546a04

Update the release page

• Write release notes in the release page

• Add the relevant artifacts to the release page from the 5952 buldkite 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

• 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