Skip to content

Fix daml.yaml example to match actual dpm init output - #1219

Draft
8bitpal wants to merge 1 commit into
mainfrom
content/fix-dpm-init-daml-yaml-1196
Draft

Fix daml.yaml example to match actual dpm init output#1219
8bitpal wants to merge 1 commit into
mainfrom
content/fix-dpm-init-daml-yaml-1196

Conversation

@8bitpal

@8bitpal 8bitpal commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

Closes #1196.

The documented dpm init example daml.yaml didn't match actual output. Per the repro in the issue (dpm 1.0.21, SDK 3.5.3):

name: .
source: daml
version: 0.0.1
dependencies:
  - daml-prim
  - daml-stdlib
  - daml-script

vs. the documented example which had sdk-version, name: my-project, version: 1.0.0, no daml-script dependency, and a build-options block — none of which dpm init actually generates.

  • Updated the example snippet to match the real output.
  • Updated the "Key fields" list: sdk-version and build-options are valid daml.yaml fields but aren't set by dpm init; noted that sdk-version, when absent, falls back to the globally active SDK version (dpm version --active).

The documented example included sdk-version and build-options fields
and different defaults for name/version/dependencies than dpm init
(1.0.21) actually generates. Updated the example to match, and
clarified in the key fields list that sdk-version and build-options
are optional fields dpm init does not set, with sdk-version falling
back to the globally active SDK version when absent.

Signed-off-by: 8bitpal <elias@zerolimit.es>
@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cantonfoundation 🟢 Ready View Preview Aug 4, 2026, 3:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Issue on docs: dpm init produces a different daml.yaml file than the one documented

2 participants