However, the name property could prove confusing for our users because now we have two different concepts of name, one of which is only ever applicable in the context of pulumi convert. This might not be what users expect if they are choosing YAML because of its simplicity
We should reconsider and think about ways we can eliminate the need for a logical name e.g. by automatically disambiguating the lexical name during pulumi convert and not using the __logicalName attribute at all.
⚠️ Also we haven't added docs to the feature to mention that it is possible to use a logical name; We should somehow enforce updating docs whenever we change the schema of a YAML program
Example
N/A
Output of pulumi about
CLI
Version 3.121.0
Go Version go1.22.4
Go Compiler gc
What happened?
In https://github.com/pulumi/pulumi-yaml/pull/546 we have added support for specifying logical names in YAML programs. These were necessary because we might be converting PCL programs to YAML that have different lexical name but the same logical name (as seen in https://github.com/pulumi/pulumi-yaml/issues/539)
However, the
nameproperty could prove confusing for our users because now we have two different concepts of name, one of which is only ever applicable in the context of pulumi convert. This might not be what users expect if they are choosing YAML because of its simplicityWe should reconsider and think about ways we can eliminate the need for a logical name e.g. by automatically disambiguating the lexical name during
pulumi convertand not using the__logicalNameattribute at all.⚠️ Also we haven't added docs to the feature to mention that it is possible to use a logical name; We should somehow enforce updating docs whenever we change the schema of a YAML program
Example
N/A
Output of
pulumi aboutCLI
Version 3.121.0 Go Version go1.22.4 Go Compiler gc
Host
OS darwin Version 13.2.1 Arch arm64
Additional context
No response
Contributing
No response