Skip to content

Release v2024‐05‐05

paolino edited this page Jul 8, 2024 · 1 revision

Prepare the release process

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:

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