Document the Language Version 2.0 Triggers #14866
Conversation
|
Test this change out locally with the following install scripts (Action run 10478271557) VSCode
Azure CLI
|
| @@ -0,0 +1,11 @@ | |||
| # Language Version 2.0 Triggers | |||
There was a problem hiding this comment.
Should this go in MSDocs instead of on GitHub?
| @@ -0,0 +1,11 @@ | |||
| # Language Version 2.0 Triggers | |||
|
|
|||
| We have recently developed a new Language Version 2.0, which provides a new format for resource definitions when transpiling to an ARM Template. | |||
There was a problem hiding this comment.
We should link to the docs on this: https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#languageversion-20
|
|
||
| We have recently developed a new Language Version 2.0, which provides a new format for resource definitions when transpiling to an ARM Template. | ||
|
|
||
| However, with this new language version, we noticed that it may cause breaking changes in some use cases. |
There was a problem hiding this comment.
As a customer, this sentence wouldn't give me a lot of confidence in our engineering quality bar. "may cause breaking changes" doesn't give me any ability to evaluate risk when deciding to adopt the feature, and sounds like something I'd need to be very concerned about.
Could we make this more precise (e.g. "we are aware of the following behavioral differences", followed by a list with links to issues)?
| To avoid triggering Language Version 2.0, we recommend avoiding the following: | ||
| * Using user-defined types | ||
| * Using user-defined functions | ||
| * Using compile-time imports | ||
| * Using experimental features |
There was a problem hiding this comment.
This feels unnecessarily negative. Could we invert it?
"Using any of following features will automatically enable language version 2.0 code generation:"
Added an article on triggers for Language Version 2.0 to have it documented in our repo, in case anyone wants to avoid triggering the new language version.
Microsoft Reviewers: Open in CodeFlow