Daml Finance Release Journal for SDK 2.8.0

[johan-da]

Daml Finance Release Journal for SDK 2.8.0

Release of Daml 2.8.0

Daml Finance: on GitHub
Daml Bundle: on Artifactory (including Daml Finance) and on GitHub
Release notes: 2.8.0

Useful links

Daml Finance Release instructions
Daml Release Planning
Slack temp-release-2-8-0 channel
Github daml-finance rc-8
Github daml release/2.8.x branch
Github docs.daml.com main
SDK release notes
Daml Finance release notes
Release Journal for 2.7.0

Updates to Release Process

1. Get Daml SDK from github with fallback artifactory: get daml from Artifactory when needed #1166
2. Create a daml-finance bundle to be included in the SDK bundle: git tag sdk/2.8.0-rc.1 followed by git push origin sdk/2.8.0-rc.1 now creates a bundle including snapshot packages. Consider adjusting the script to optionally include snapshots --> Consider generalizing the CI bundle script #1176
3. Keep shell.nix in sync (CI will notice & fail): If sdk-version or daml-version is changed (in the daml.yaml file), run bin/update-daml-hashes. You may need to comment out daml from the buildInputs list to get the Nix shell to run while you update the hashes. --> get daml from Artifactory when needed #1166
4. Test quick-starter and tutorial with a script: There is a new script for testing the quick-starter and tutorials with the newest SDK (installed from os Github with fallback ee Artifactory). We might want to integrate this script in our CI. --> Integrate test of quick-starter and tutorials in the CI #1175
5. Improvement Idea: For an SDK release, we could consider making use of the Daml Finance bundle as the default package set for both the quick-starter and the tutorials. Initially, this approach eliminates the need for a quick-starter and tutorial configuration file (0.0.4.conf), simplifying the setup. Only in scenarios where we need to override the default packages would we create a configuration file (i.e., 0.0.4.conf). Should such a file exist (in main), it would specify the package versions to be used in the quick-starter and tutorials for the corresponding version (0.0.4) which is set in the daml.yaml.template file. --> Improvement Idea: Consider leveraging the Daml Finance bundle #1177

Release Journal

20231215 Cleanup

• Update README files--> Update readme files #1178
• Clean up main after release --> Cleanup #1188
  - Flush changelog in main
  - Forward port doc changes to main
  - Bump assembly version in main to 1.4.0
  - Create a new tutorial configutation file (0.0.5.conf) and change the version in daml.yaml and daml.yaml.template, accordingly
• Forward port changes to 2.8 docs to 2.9/3.0 --> already up to date
• Make new assembly for 1.4.0 abd point 2.9/3.0 daml finance docs to new 1.4.0 assembly --> https://github.com/digital-asset/daml-finance/tree/assembly-1.4.0
  Daml Finance: Update version docs.daml.com#590
• Update daml hashes in main once SDK is officially released --> bump daml hashes #1189

20231215 Release Candidate Announced Stable

• Bump to official package versions (in daml-finance rc-2.8) --> Bump to official package versions #1184 (includes a script to check that versions match the expected ones)
• Bump to official SDK version (in daml-finance rc-2.8) --> Bump to official sdk version #1185
• Test e2e scripts
• Test quick-starter and tutorials (once the new SDK candidate is released)
• Release official packages --> https://github.com/digital-asset/daml-finance/tree/
• Release official package bundle in Github (and communicate tag to SDK release coordinator) --> https://github.com/digital-asset/daml-finance/releases/tag/sdk%2F2.8.0
  - git tag sdk/2.8.0 + git push sdk/2.8.0 triggers the bundle of the latest released versions
  - double check that the bundle contains the right versions
• Update the 0.0.4.conf file in the daml-finance in main branch with the latest released packages --> merged the rc-2.8 to main RC 2.8 #1186

20231214 Daml RC5

• Bump SDK version, package versions, and update hashes (in daml-finance rc-2.8) --> https://github.com/digital-asset/daml-finance/tree/test-sdk-rc5
• Make snapshot release --> Previous was used
• Update the 0.0.4.conf file in the daml-finance main branch with the latest released snapshot packages --> Previous was used
• Update version in daml (can be skipped if the quick-starter and tutorials did not change since last update) --> Previous was used
• Create bundle --> Previous was used
• Test quick-starter and tutorials (once the new SDK candidate is released)

20231212 Daml RC4

• Bump SDK version, package versions, and update hashes (in daml-finance rc-2.8) --> a614ab4
• Test e2e scripts
• Make snapshot release --> Previous was used
• Update the 0.0.4.conf file in the daml-finance main branch with the latest released snapshot packages --> Previous was used
• Update version in daml (can be skipped if the quick-starter and tutorials did not change since last update) --> Previous was used
• Create bundle --> Previous was used
• Test quick-starter and tutorials (once the new SDK candidate is released)

20231207 Daml RC3

• Bump SDK version, package versions, and update hashes (in daml-finance rc-2.8) --> 1a24b27
  - fixed the script: 16e23ce
• Test e2e scripts
• Make snapshot release --> Previous was used
• Update the 0.0.4.conf file in the daml-finance main branch with the latest released snapshot packages --> Previous was used
• Update version in daml (can be skipped if the quick-starter and tutorials did not change since last update) --> Previous was used
• Create bundle --> Previous was used
• Test quick-starter and tutorials (once the new SDK candidate is released)

20231207 Daml RC2

• Bump SDK version, package versions, and update hashes (in daml-finance rc-2.8) --> bump daml for rc-2 #1182
  - the hash computation was adjusted due to lacking --to-base-64 flag for the nix-hash function
  - the --allow-install-non-release=yes install flag was changed to --install-with-internal-version yes , so had to adjust scripts accordingly
• Test e2e scripts
• Make snapshot release --> Previous was used
• Update the 0.0.4.conf file in the daml-finance main branch with the latest released snapshot packages --> Previous was used
• Update version in daml (can be skipped if the quick-starter and tutorials did not change since last update) --> Previous was used
• Create bundle --> Previous was used
• Test quick-starter and tutorials (once the new SDK candidate is released)

20231205 Scripts

• Add test-sdk-daml-finance-templates script
  - Install SDK from os with ee as fallback
  - Get latest SDK version from github tag
• Add script for sorting Daml imports --> Script for sorting daml imports #1181

20231129 Rename conf file (2.8.0.conf to 0.0.4.conf)

• Change in daml-finance main --> Changing version for conf file #1172
• Backport change to daml-finance rc-2.8
• Update version in daml (to effectuate name change) --> Daml Finance: update version daml#17948
• Backport change to 2.8.x --> https://github.com/digital-asset/daml/pull/17949/files
• Had to add back 2.8.0.conf to main after revival of the RC1 testing --> Adding back 2.8.0.conf file (for testing RC1) #1179
• Remove 2.8.0.conf file from main in case of RC2 --> Remove redundant conf file #1183

20231127 Daml RC1

sdk-version: 2.8.0-snapshot.20231127.12403.0.vf5c2e6da (sourced from Jfrog Artifactory)
daml-version: 2.8.0-rc1 (not used when sourced from artifactory, and will soon be the same as sdk-version again)

• Bump SDK version, package versions, and update hashes (in daml-finance rc-2.8) --> get daml from Artifactory when needed #1166
• Test e2e scripts
• Make snapshot release --> https://github.com/digital-asset/daml-finance/tree/release-snapshot-20231127
• Update the 2.8.0.conf file in the daml-finance main branch with the latest released snapshot packages
• Update version in daml --> Daml Finance: Update version daml#17874
• Create bundle --> https://github.com/digital-asset/daml-finance/releases/tag/sdk%2F2.8.0-rc.1
  (Bundle script had to be amended to include snapshot packages --> 94c9fbb)
• Test quick-starter and tutorials (once the new SDK candidate is released):
  - 20231129 Last line in conf file must be empty (for the scripts to work properly) --> Add empty line to conf file #1171
  - 20231129 Reported on an issue damlc: user error (Package dependencies from different SDK versions: 2.8.0-rc1, 2.8.0-snapshot.20231127.12403.0.vf5c2e6da) --> There will be a new release candidate.
  - 20231130 All tests ran successfully for RC1

20231118 SDK Snapshot

sdk-version: 2.8.0-snapshot.20231118.12382.0.v86cb8054
daml-version: 2.8.0-snapshot.20231122.0

• Bump SDK versions (in daml-finance rc-2.8) --> Upgrade SDK version #1163
• Test e2e scripts
• Test quick-starter and tutorials (with the latest SDK snapshot)

20231116 SDK Snapshot

sdk-version: 2.8.0-snapshot.20231116.12377.0.va821d52f
daml-version: 2.8.0-snapshot.20231117.0

• Bump SDK version in daml-finance rc-2.8
• Test e2e scripts
• Test quick-starter and tutorials (with the latest SDK snapshot)

20231121 Daml Finance Snapshot

sdk-version: 2.8.0-snapshot.20231116.12377.0.va821d52f
daml-version: 2.8.0-snapshot.20231117.0

• Bump the SDK version and package versions (in daml-finance rc-2.8)
  (had to amend scripts to handle multiple versions -->
  Updating the sdk version to RC snapshot #1159
  Update dates for snapshot #1160)
• Test e2e scripts
• Make snapshot release --> https://github.com/digital-asset/daml-finance/tree/release-snapshot-20231121
• Update the 2.8.0.conf file in the daml-finance main branch with the latest released snapshot packages. Added 2.8.0.latest.conf to keep track of the upcoming unreleased packages. Once released, simply copy and paste their details into 2.8.0.conf (make sure there is an empty line at the end) --> Updates for latest snapshot release #1161
• Update version in daml --> Daml Finance: Update version daml#17874
• Test quick-starter and tutorials (with the latest SDK snapshot).
  (Added a daml-finance/scripts/test-quickstarter-and-tutorials.sh bash script to facilitate the testing --> Adding test script for templates #1164.)

20231115 Daml Finance Snapshot

sdk-version: 2.7.4

• Bump SDK version and package versions (in daml-finance rc-2.8) --> fix versions + update SDK #1146
• Test e2e scripts
• Make snapshot release
• Update the 2.8.0.conf file in the daml-finance main branch (NOTE: it was later renamed to 0.0.4.conf)
• Update version in daml --> Daml Finance: update version daml#17845
• Test quick-starter and tutorials (with the latest SDK snapshot)

Preparation

Update Docs

• Bump assembly version for docs --> https://github.com/digital-asset/daml-finance/tree/assembly-1.3.10
• Polish change-log (update it, reword it, hide non-user-facing changes) --> Remove unused function + change log updates #1149
• Update list of released packages / deprecated packages --> Daml Finance: Adding changelog and release notes docs.daml.com#549
• Add per-package changelog --> Daml Finance: Adding changelog and release notes docs.daml.com#549
• Add 'Major Updates' section to the docs -->
  Daml Finance: Adding changelog and release notes docs.daml.com#549
  Daml Finance: release notes adjustments docs.daml.com#552
• Review release notes

Update Quick-Starter and Tutorials

• Add new tutorial to daml repo --> 196435d Daml Finance: Update quickstarter version + hash daml#17840 (review)
• Update daml_finance_dep.bzl version in the daml repo and backport change to daml release branch release/2.8.x (if already available)--> Daml Finance: Update quickstarter version + hash daml#17840 (review)
• Test quick-starter and tutorials (with the latest SDK snapshot release)