# Terraform CDK github Provider ~> 4.0
This repo builds and publishes the Terraform github Provider bindings for [cdktf](https://cdk.tf).
## Available Packages
### NPM
The npm package is available at [https://www.npmjs.com/package/@cdktf/provider-github](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](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](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](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>
```
## Docs
Find auto-generated docs for this provider here: [./API.md](./API.md)
## Versioning
This project is explicitly not tracking the Terraform github Provider version 1:1. In fact, it always tracks `latest` of `~> 4.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](https://cdk.tf/imports).
These are the upstream dependencies:
* [Terraform CDK](https://cdk.tf)
* [Terraform github Provider](https://github.com/terraform-providers/terraform-provider-github)
* [Terraform Engine](https://terraform.io)
If there are breaking changes (backward incompatible) in any of the above, the major version of this project will be bumped. While the Terraform Engine and the Terraform github Provider are relatively stable, the Terraform CDK is in an early stage. Therefore, it's likely that there will be breaking changes.
## Features / Issues / Bugs
Please report bugs and issues to the [terraform cdk](https://cdk.tf) project:
* [Create bug report](https://cdk.tf/bug)
* [Create feature request](https://cdk.tf/feature)
## Contributing
### projen
This is mostly based on [projen](https://github.com/eladb/projen), which takes care of generating the entire repository.
### cdktf-provider-project based on projen
There's a custom [project builder](https://github.com/hashicorp/cdktf-provider-project) which encapsulate the common settings for all `cdktf` providers.
### Provider Version
The provider version can be adjusted in [./.projenrc.js](./.projenrc.js).
### Repository Management
The repository is managed by [Repository Manager](https://github.com/hashicorp/cdktf-repository-manager/)
评论0