cdktf-registry-docs v1.25.0
CDKTF Registry Docs
This CLI tool use cdktf convert
on HCL snippets in the registry documentation to generate a new markdown document with translated code blocks. This will then be used by the registry to allow showing the same documentation for a different CDKTF language.
Usage
Within the root of a terraform provider run
npm install -g cdktf-registry-docs
cdktf-registry-docs provider --provider-from-registry="hashicorp/aws@~> 4.0" ./
CI
Single GitHub Action running on a cron / push
name: CDKTF Doc Translation
on:
# You can decide between push / schedule or whatever trigger you need
# push:
# branches:
# - main
# - "release/**"
# paths:
# - .github/workflows/cdktf-documentation.yml
# - website/docs/**
schedule:
- cron: "0 0 * * WED"
workflow_dispatch: {}
jobs:
cdktfDocs:
uses: hashicorp/cdktf-registry-docs/.github/workflows/pr-based-rollout.yml@214d7d9273e8540bc281a92a425c9b2d0436dfd9
secrets:
GH_PR_TOKEN: ${{ secrets.TF_WORKFLOW_GITHUB_TOKEN }}
with:
providerFqn: "hashicorp/aws"
files: "*/ec2_*.html.markdown"
26 days ago
1 month ago
2 months ago
2 months ago
3 months ago
4 months ago
4 months ago
4 months ago
9 months ago
10 months ago
10 months ago
6 months ago
6 months ago
6 months ago
6 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
11 months ago
12 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago