Repository navigation
docs: refresh generated API reference for cdktn v0.23.4 - #22
Merged
Merged
Conversation
Regenerated from the published `cdktn@0.23.4` JSII assembly (no monorepo build — the npm tarball ships `.jsii` at its root) via `tools/documentation-generation`, against `constructs@^10.6.0` as required by 0.23.4's peer dependency. Real API changes: - `Fn` / `Fn`-generated: 7 new cross-product functions covering Terraform and OpenTofu — `base`, `cidrcontains`, `convert`, `ephemeralasnull`, `issensitive`, `templatestring`, `urldecode` (open-constructs/cdk-terrain#268) - `S3BackendConfig` (and `DataTerraformRemoteStateS3Config`): new `useLockfile` field; `dynamodbTable` deprecated in favor of it (open-constructs/cdk-terrain#234) - All construct pages: inherited `with(...mixins)` method surfaced by constructs 10.6 (previous docs were generated against the tool's stale `constructs@10.3.0` pin, which no longer satisfies 0.23.4's `^10.6.0`) Of 925 files, 705 differ only in the generator banner (`yarn` -> `pnpm` generate-docs), a byproduct of the package-manager migration in the current generator template. Navigation (`docs.json`) is unchanged: no classes/structs were added or removed, only members on existing types. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
so0k
added a commit
that referenced
this pull request
Jul 3, 2026
Mixins have been available since CDKTN 0.23.0 (cdk-terrain#164), which raised the constructs peer to ^10.6.0 (cdk-terrain#20). PR #22 only surfaced with() in the API reference (stale since 0.23.2) — it was not new in 0.23.4. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes the generated API reference to match the newly published
cdktn@0.23.4.Generated from the published npm tarball's
.jsiiassembly (no monorepo build needed — jsii-docgen only consumes the assembly) viatools/documentation-generation, againstconstructs@^10.6.0as required by 0.23.4's peer dependency.Real API changes
Fn/Fn-generated — 7 new cross-product functions covering Terraform and OpenTofu:base,cidrcontains,convert,ephemeralasnull,issensitive,templatestring,urldecode(feat(lib): validate Fn usage against Terraform/OpenTofu versions cdk-terrain#268)S3BackendConfig(andDataTerraformRemoteStateS3Config) — newuseLockfilefield;dynamodbTablenow deprecated in favor of it (feat(lib): S3-backend - AdduseLockfilefield and updatedynamodbTabledeprecated JSDoc cdk-terrain#234)with(...mixins)method now surfaced by constructs 10.6. The previously committed docs were generated against the doc tool's staleconstructs@10.3.0pin, which no longer satisfies 0.23.4's^10.6.0requirement.Noise disclosure
Of 925 changed files, 705 differ only in the generator banner (
{/* This file is generated through yarn generate-docs */}→pnpm), a byproduct of the yarn→pnpm migration baked into the current generator template. The remaining 220 carry the real changes above.Navigation (
docs.json) is unchanged — no classes/structs were added or removed in 0.23.4, only members on existing types.🤖 Generated with Claude Code