Skip to content

docs: point deployment patterns at cdktn-io/action (OpenTofu)#25

Open
so0k wants to merge 1 commit into
mainfrom
docs/cdktn-action-deployment
Open

docs: point deployment patterns at cdktn-io/action (OpenTofu)#25
so0k wants to merge 1 commit into
mainfrom
docs/cdktn-action-deployment

Conversation

@so0k

@so0k so0k commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

What

Updates the Create and Deploy → Deployment Patterns page: the "GitHub Action" subsection previously pointed at HashiCorp's archived terraform-cdk-action. It now documents the maintained successor, cdktn-io/action.

Changes

  • Renamed the subsection to CDK Terrain GitHub Action and pointed it at cdktn-io/action.
  • Added a <Note> calling out that it replaces the archived HashiCorp action.
  • Added an OpenTofu-first workflow example: opentofu/setup-opentofu (tofu_wrapper: false), engine/mode inputs, and a note that the action verifies (not installs) the engine and engine: auto auto-detects (prefers OpenTofu).
  • Linked a complete runnable example: vincenthsh/cdktn-docker-demo — its e2e runs cdktn plan on OpenTofu via this action (Plan: 2 to add).
  • HCP Terraform references retained (kept the cloudToken/TF_API_TOKEN usage and the existing HCP section below unchanged).

Notes

  • The example pins cdktn-io/action@main for now, with a comment to pin to a released tag once one is published.
  • No docs.json change — this updates an existing page in place.

🤖 Generated with Claude Code

… cdktn-io/action

Point the GitHub Action section at cdktn-io/action (the maintained successor to
HashiCorp's archived terraform-cdk-action), with an OpenTofu-first workflow
example (setup-opentofu + engine/modes) and a link to the runnable
vincenthsh/cdktn-docker-demo. HCP Terraform references retained.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 5, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cdkterrain 🟢 Ready View Preview Jul 5, 2026, 4:34 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

githubToken: ${{ github.token }}
```

For a complete, runnable example see [`vincenthsh/cdktn-docker-demo`](https://github.com/vincenthsh/cdktn-docker-demo). The [action inputs](https://github.com/cdktn-io/action#inputs) document all options, including the `auto-approve-apply` / `auto-approve-destroy` deployment modes and HCP Terraform configuration.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should move demo to a cdktn-samples org?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant