[schema] Add IsOverlay option to disable codegen for particular types #8338
Conversation
|
Diff for pulumi-azuread with merge commit 618d323 |
|
Diff for pulumi-random with merge commit 618d323 |
|
Diff for pulumi-kubernetes with merge commit 618d323 |
|
Diff for pulumi-gcp with merge commit 618d323 |
|
Diff for pulumi-azure with merge commit 618d323 |
|
Diff for pulumi-aws with merge commit 618d323 |
|
Diff for pulumi-azure-native with merge commit 618d323 |
|
This seems pretty reasonable to me. Feels like we might want this on all schema members (i.e. types and functions in addition to resources). |
lblackstone
force-pushed
the
lblackstone/overlay-schema
branch
from
9a11f17
to
912feb3
Compare
Ha, just pushed an update that expands it to types. Let me check if that also supports functions. |
|
Diff for pulumi-random with merge commit cbb951e |
|
Diff for pulumi-azuread with merge commit cbb951e |
|
Diff for pulumi-kubernetes with merge commit cbb951e |
lblackstone
changed the title
|
Diff for pulumi-gcp with merge commit cbb951e |
|
Diff for pulumi-azuread with merge commit 7cde596 |
|
Diff for pulumi-random with merge commit 7cde596 |
|
Diff for pulumi-kubernetes with merge commit 7cde596 |
|
Diff for pulumi-gcp with merge commit 7cde596 |
|
Diff for pulumi-aws with merge commit cbb951e |
|
Diff for pulumi-azure with merge commit cbb951e |
|
Diff for pulumi-aws with merge commit 7cde596 |
|
Diff for pulumi-azure with merge commit 7cde596 |
lblackstone
force-pushed
the
lblackstone/overlay-schema
branch
from
561b1c3
to
d33ce7e
Compare
lblackstone
added
the
impact/no-changelog-required
|
Diff for pulumi-random with merge commit 26945dd |
|
Diff for pulumi-azuread with merge commit 26945dd |
|
Diff for pulumi-kubernetes with merge commit 26945dd |
|
Diff for pulumi-gcp with merge commit 26945dd |
|
Diff for pulumi-azure with merge commit 26945dd |
|
Diff for pulumi-aws with merge commit 26945dd |
|
Diff for pulumi-azure-native with merge commit 26945dd |
|
Diff for pulumi-azuread with merge commit 767c0f9 |
|
Diff for pulumi-random with merge commit 767c0f9 |
|
Diff for pulumi-kubernetes with merge commit 767c0f9 |
|
Diff for pulumi-gcp with merge commit 767c0f9 |
|
Diff for pulumi-azure with merge commit 767c0f9 |
|
Diff for pulumi-aws with merge commit 767c0f9 |
|
Diff for pulumi-azure-native with merge commit 767c0f9 |
|
Diff for pulumi-azuread with merge commit fbceb96 |
|
Diff for pulumi-random with merge commit fbceb96 |
|
Diff for pulumi-kubernetes with merge commit fbceb96 |
|
Diff for pulumi-gcp with merge commit fbceb96 |
|
Diff for pulumi-azure with merge commit fbceb96 |
|
Diff for pulumi-aws with merge commit fbceb96 |
| @@ -3248,7 +3290,7 @@ func GeneratePackage(tool string, pkg *schema.Package) (map[string][]byte, error | |||
| } | |||
|
|
|||
| // If there are resources in this module, register the module with the runtime. | |||
| if len(pkg.resources) != 0 { | |||
| if len(pkg.resources) != 0 && !allResourcesAreOverlays(pkg.resources) { | |||
|
Diff for pulumi-azure-native with merge commit fbceb96 |
And update the metaschema to accommodate the `isOverlay` properties added in #8338. Overlay enums, like other overlay members, are implemented out-of-band by the declaring package. Code generators should not generate declarations for overlay enums.
And update the metaschema to accommodate the `isOverlay` properties added in #8338. Overlay enums, like other overlay members, are implemented out-of-band by the declaring package. Code generators should not generate declarations for overlay enums.
Description
Related to pulumi/docs#6740
Add a new
IsOverlayoption to schema types and functions that allows providers to document overlays in the schema. This makes it easier to generate API docs consistently, even for code that is generated outside of the typical codegen process.Fixes # (issue)
Checklist