daml/release/RELEASE.md

2.6 KiB

Making a Release

  1. Make a PR that bumps the version number in the VERSION file and adds a new header and label for the new version in docs/source/support/release-notes.rst (see previous releases as examples). It is important that the PR only changes VERSION and release-notes.rst.

  2. "Squash and merge" the PR.

  3. Once CI has passed for the corresponding master build, the release should be available on bintray and GitHub, as well as properly tagged.

  4. Activate the new version with da use VERSION. Note that it will not be picked up by da upgrade at this point.

  5. Run through the manual test plan described in https://docs.google.com/document/d/16amcy7bQodXSHjEmKhAUiaPf6O92gUbch1OyixDEvSM/edit?ts=5ca5be00.

    The test plan currently still targets the old da assistant. We will migrate the test plan fully to the new assistant soon but for now, there is a shorter test plan for the new assistant that you should run on Windows:

    1. Download the installer from https://github.com/digital-asset/daml/releases
    2. Remove any existing installation: rm -r -Force $env:AppData\daml
    3. Run the installer.
    4. Open a new Powershell.
    5. Run daml new quickstart to create a new project.
    6. Switch to the new project: cd quickstart
    7. Run daml start.
    8. Open your browser at http://localhost:7500, verify that you can login as Alice and there is one template and one contract.
    9. Kill daml start with Ctrl-C
    10. Run daml studio and open daml/Main.daml.
    11. Verify that the scenario result appears within 30 seconds.
    12. Add + at the end of line 26 after "Alice" and verify that you get a red squiggly line.
  6. If it passes, the release should be made public. This currently consists of three steps:

    1. Tag the release as visible-external on Bintray. This step can only be done by someone with permissions to set tags on Bintray. After this step the release will be picked up by da upgrade. Note that this step requires special privileges on Bintray. If you cannot change it yourself, ask in #team-daml.

    2. Trigger the CircleCI jobs to create the Docker images. To do so, go to https://circleci.com/gh/DACH-NY/workflows/damlc-docker/tree/master and click "rerun" on "master / Main Variant" and on "master / CircleCI Variant". Once the jobs have passed, you should see two new images on https://hub.docker.com/r/digitalasset/daml-sdk/tags.

    3. Publish the draft release on GitHub by going to the releases page and clicking the Edit button for the relevant release.