Skip to content

Prebuilt Terraform CDK (cdktf) provider for github.

License

Notifications You must be signed in to change notification settings

cdktf/cdktf-provider-github

CDKTF prebuilt bindings for integrations/github provider version 6.3.1

This repo builds and publishes the Terraform github provider bindings for CDK for Terraform.

Available Packages

NPM

The npm package is available at https://www.npmjs.com/package/@cdktf/provider-github.

npm install @cdktf/provider-github

PyPI

The PyPI package is available at https://pypi.org/project/cdktf-cdktf-provider-github.

pipenv install cdktf-cdktf-provider-github

Nuget

The Nuget package is available at https://www.nuget.org/packages/HashiCorp.Cdktf.Providers.Github.

dotnet add package HashiCorp.Cdktf.Providers.Github

Maven

The Maven package is available at https://mvnrepository.com/artifact/com.hashicorp/cdktf-provider-github.

<dependency>
    <groupId>com.hashicorp</groupId>
    <artifactId>cdktf-provider-github</artifactId>
    <version>[REPLACE WITH DESIRED VERSION]</version>
</dependency>

Go

The go package is generated into the github.com/cdktf/cdktf-provider-github-go package.

go get github.com/cdktf/cdktf-provider-github-go/github/<version>

Where <version> is the version of the prebuilt provider you would like to use e.g. v11. The full module name can be found within the go.mod file.

Docs

Find auto-generated docs for this provider here:

You can also visit a hosted version of the documentation on constructs.dev.

Versioning

This project is explicitly not tracking the Terraform github provider version 1:1. In fact, it always tracks latest of ~> 6.0 with every release. If there are scenarios where you explicitly have to pin your provider version, you can do so by generating the provider constructs manually.

These are the upstream dependencies:

If there are breaking changes (backward incompatible) in any of the above, the major version of this project will be bumped.

Features / Issues / Bugs

Please report bugs and issues to the CDK for Terraform project:

Contributing

Projen

This is mostly based on Projen, which takes care of generating the entire repository.

cdktf-provider-project based on Projen

There's a custom project builder which encapsulate the common settings for all cdktf prebuilt providers.

Provider Version

The provider version can be adjusted in ./.projenrc.js.

Repository Management

The repository is managed by CDKTF Repository Manager.