mirror of https://github.com/pulumi/pulumi.git
74e8928cff
The existing overlays (e.g. Chart v3 in Kubernetes, or CallbackFunction in AWS) are not available in every language Pulumi supports. This often confuses users because the generated docs include all languages Pulumi supports (e.g. see https://github.com/pulumi/pulumi-kubernetes/issues/2181). To solve that problem, this change adds a new optional parameter to the schema that allows configuring the languages an overlay (resource or function) supports. To support this in docsgen the existing Language Chooser (`LangChooserLanguages`) of resources is made configurable and extended to functions. Note: This doesn't support resource methods right now. They'll need extra handling because and overlay resource method might not support all of the languages its resource supports. I'll tackle this in a follow up PR. Here's a screenshot of how this will look like for the Helm v3 chart for example: <img width="1046" alt="Screenshot 2024-07-01 at 16 11 23" src="https://github.com/pulumi/pulumi/assets/2453580/b1a1365a-6dee-4099-829a-2859639a4c8c"> The PR contains the following commits. I'd recommend to look at the first three ones and then check the regenerated golden files in the last one: - **Add schema parameter to constrain supported languages for overlays** - **Update developer docs and changelog** - **Refactor LanguageChooser and always pass supported languages** - **Regenerate testdata** relates to #13231 |
||
|---|---|---|
| .. | ||
| bad-enum-1.json | ||
| bad-enum-2.json | ||
| bad-enum-3.json | ||
| bad-enum-4.json | ||
| bad-methods-1.json | ||
| bad-methods-2.json | ||
| bad-methods-3.json | ||
| bad-methods-4.json | ||
| bad-methods-5.json | ||
| bad-methods-6.json | ||
| bad-type-1.json | ||
| bad-type-2.json | ||
| bad-type-3.json | ||
| bad-type-4.json | ||
| good-enum-1.json | ||
| good-enum-2.json | ||
| good-enum-3.json | ||
| good-enum-4.json | ||
| good-methods-1.json | ||
| good-simplified-methods.json | ||
| good-simplified-methods.yml | ||
| overlay-supported-languages.json | ||
| overlay.json | ||
| replace-on-changes-1.json | ||
| replace-on-changes-2.json | ||
| replace-on-changes-3.json | ||
| replace-on-changes-4.json | ||
| replace-on-changes-5.json | ||
| replace-on-changes-6.json | ||