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 --> https://github.com/digital-asset/daml-finance/issues/1176
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. --> https://github.com/digital-asset/daml-finance/pull/1166
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. --> https://github.com/digital-asset/daml-finance/issues/1175
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. --> https://github.com/digital-asset/daml-finance/issues/1177
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)
20231129 Reported on an issuedamlc: 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.
[x] 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) --> https://github.com/digital-asset/daml-finance/pull/1161
[x] 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 --> https://github.com/digital-asset/daml-finance/pull/1164.)
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
git tag sdk/2.8.0-rc.1
followed bygit push origin sdk/2.8.0-rc.1
now creates a bundle including snapshot packages. Consider adjusting the script to optionally include snapshots --> https://github.com/digital-asset/daml-finance/issues/1176shell.nix
in sync (CI will notice & fail): If sdk-version or daml-version is changed (in thedaml.yaml
file), runbin/update-daml-hashes
. You may need to comment outdaml
from thebuildInputs
list to get the Nix shell to run while you update the hashes. --> https://github.com/digital-asset/daml-finance/pull/1166os
Github with fallbackee
Artifactory). We might want to integrate this script in our CI. --> https://github.com/digital-asset/daml-finance/issues/11750.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 (inmain
), 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 thedaml.yaml.template
file. --> https://github.com/digital-asset/daml-finance/issues/1177Release Journal
20231215 Cleanup
1.4.0
0.0.5.conf
) and change the version indaml.yaml
anddaml.yaml.template
, accordingly2.8
docs to2.9
/3.0
--> already up to date1.4.0
abd point2.9/3.0
daml finance docs to new1.4.0
assembly --> https://github.com/digital-asset/daml-finance/tree/assembly-1.4.0 https://github.com/digital-asset/docs.daml.com/pull/59020231215 Release Candidate Announced Stable
rc-2.8
) --> https://github.com/digital-asset/daml-finance/pull/1184 (includes a script to check that versions match the expected ones)rc-2.8
) --> https://github.com/digital-asset/daml-finance/pull/1185git tag sdk/2.8.0
+git push sdk/2.8.0
triggers the bundle of the latest released versions0.0.4.conf
file in the daml-finance inmain
branch with the latest released packages --> merged therc-2.8
to main https://github.com/digital-asset/daml-finance/pull/118620231214 Daml RC5
rc-2.8
) --> https://github.com/digital-asset/daml-finance/tree/test-sdk-rc50.0.4.conf
file in the daml-financemain
branch with the latest released snapshot packages --> Previous was used20231212 Daml RC4
rc-2.8
) --> https://github.com/digital-asset/daml-finance/commit/a614ab4f05ac41fa249c4980e8df442cfadf4d4a0.0.4.conf
file in the daml-financemain
branch with the latest released snapshot packages --> Previous was used20231207 Daml RC3
rc-2.8
) --> https://github.com/digital-asset/daml-finance/commit/1a24b27ad85f3bc7eeeab1dff64e8eb2307b862a0.0.4.conf
file in the daml-financemain
branch with the latest released snapshot packages --> Previous was used20231207 Daml RC2
rc-2.8
) --> https://github.com/digital-asset/daml-finance/pull/1182--to-base-64
flag for thenix-hash
function--allow-install-non-release=yes
install flag was changed to--install-with-internal-version yes
, so had to adjust scripts accordingly0.0.4.conf
file in the daml-financemain
branch with the latest released snapshot packages --> Previous was used20231205 Scripts
20231129 Rename conf file (2.8.0.conf to 0.0.4.conf)
rc-2.8
2.8.x
--> https://github.com/digital-asset/daml/pull/17949/files2.8.0.conf
file from main in case of RC2 --> https://github.com/digital-asset/daml-finance/pull/118320231127 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)
rc-2.8
) --> https://github.com/digital-asset/daml-finance/pull/11662.8.0.conf
file in the daml-financemain
branch with the latest released snapshot packagesdamlc: 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.20231118 SDK Snapshot
sdk-version: 2.8.0-snapshot.20231118.12382.0.v86cb8054 daml-version: 2.8.0-snapshot.20231122.0
rc-2.8
) --> https://github.com/digital-asset/daml-finance/pull/116320231116 SDK Snapshot
sdk-version: 2.8.0-snapshot.20231116.12377.0.va821d52f daml-version: 2.8.0-snapshot.20231117.0
rc-2.8
20231121 Daml Finance Snapshot
sdk-version: 2.8.0-snapshot.20231116.12377.0.va821d52f daml-version: 2.8.0-snapshot.20231117.0
rc-2.8
) (had to amend scripts to handle multiple versions -->https://github.com/digital-asset/daml-finance/pull/1159 https://github.com/digital-asset/daml-finance/pull/1160)
2.8.0.conf
file in the daml-financemain
branch with the latest released snapshot packages. Added2.8.0.latest.conf
to keep track of the upcoming unreleased packages. Once released, simply copy and paste their details into2.8.0.conf
(make sure there is an empty line at the end) --> https://github.com/digital-asset/daml-finance/pull/1161daml-finance/scripts/test-quickstarter-and-tutorials.sh
bash script to facilitate the testing --> https://github.com/digital-asset/daml-finance/pull/1164.)20231115 Daml Finance Snapshot
sdk-version: 2.7.4
rc-2.8
) --> https://github.com/digital-asset/daml-finance/pull/11462.8.0.conf
file in the daml-financemain
branch (NOTE: it was later renamed to0.0.4.conf
)Preparation
Update Docs
Update Quick-Starter and Tutorials
daml_finance_dep.bzl
version in the daml repo and backport change to daml release branchrelease/2.8.x
(if already available)--> https://github.com/digital-asset/daml/pull/17840#pullrequestreview-1731519491