Skip to content

README.md

Latest commit

 

History

History
47 lines (28 loc) · 1.57 KB

README.md

File metadata and controls

47 lines (28 loc) · 1.57 KB

controller-cdktf

This repo contains the generated code for cdktf in Go. The implementation is being developed in sourcegraph/controller.

This package is only used internally at Sourcegraph - the generated code is public for ease of use and avoid performance issue with large amount of generated content being tracked in a Git repository.

Usage

Adding a new provider or module to CDKTF

Follow https://github.com/sourcegraph/cdktf-provider-gen#usage

make <target>

Upgrading CDKTF

Review the changelog of the target release. Watch out for breaking changes and adjust the upgrade plan if neccessary.

Bumpd CDKTF_VERSION in Makefile:

-CDKTF_VERSION=0.16.3
+CDKTF_VERSION=0.19.2

Re-generate all providers and modules:

make -j4

If you upgrade google terraform provider, follow the version upgrade guide eg. v6 upgrade and update the controller.

FAQ

Why not use the pre-built providers?

We would like to use specific versions of provides, hence we are not using pre-built providers, such as cdktf/cdktf-provider-google-go.

Why multiple modules instead of one?

Generated code combined from all providers and modules exceed the limit of go get, and this cannot be changed.