Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[usability] Reconsider the logical names feature for YAML programs #594

Open
Zaid-Ajaj opened this issue Jun 24, 2024 · 0 comments
Open
Labels
area/codegen `pulumi convert` impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features

Comments

@Zaid-Ajaj
Copy link
Contributor

What happened?

In #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 #539)

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

Host
OS darwin
Version 13.2.1
Arch arm64

Additional context

No response

Contributing

No response

@Zaid-Ajaj Zaid-Ajaj added impact/usability Something that impacts users' ability to use the product easily and intuitively area/codegen `pulumi convert` labels Jun 24, 2024
@mikhailshilkov mikhailshilkov added the kind/enhancement Improvements or new features label Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/codegen `pulumi convert` impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

2 participants