Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdktf/cdktf-provider-github
Prebuilt Terraform CDK (cdktf) provider for github.
https://github.com/cdktf/cdktf-provider-github
cdk cdktf github pre-built-provider provider terraform terraform-cdk
Last synced: 6 days ago
JSON representation
Prebuilt Terraform CDK (cdktf) provider for github.
- Host: GitHub
- URL: https://github.com/cdktf/cdktf-provider-github
- Owner: cdktf
- License: mpl-2.0
- Created: 2020-08-10T20:53:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T00:13:09.000Z (8 months ago)
- Last Synced: 2024-04-08T02:12:53.959Z (8 months ago)
- Topics: cdk, cdktf, github, pre-built-provider, provider, terraform, terraform-cdk
- Language: TypeScript
- Homepage: https://cdk.tf
- Size: 43.4 MB
- Stars: 14
- Watchers: 9
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CDKTF prebuilt bindings for integrations/github provider version 6.3.1
This repo builds and publishes the [Terraform github provider](https://registry.terraform.io/providers/integrations/github/6.3.1/docs) bindings for [CDK for Terraform](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).
```
com.hashicorp
cdktf-provider-github
[REPLACE WITH DESIRED VERSION]
```
### Go
The go package is generated into the [`github.com/cdktf/cdktf-provider-github-go`](https://github.com/cdktf/cdktf-provider-github-go) package.
`go get github.com/cdktf/cdktf-provider-github-go/github/`
Where `` 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](https://github.com/cdktf/cdktf-provider-github-go/blob/main/github/go.mod#L1) file.
## Docs
Find auto-generated docs for this provider here:
- [Typescript](./docs/API.typescript.md)
- [Python](./docs/API.python.md)
- [Java](./docs/API.java.md)
- [C#](./docs/API.csharp.md)
- [Go](./docs/API.go.md)
You can also visit a hosted version of the documentation on [constructs.dev](https://constructs.dev/packages/@cdktf/provider-github).
## 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](https://cdk.tf/imports).
These are the upstream dependencies:
- [CDK for Terraform](https://cdk.tf)
- [Terraform github provider](https://registry.terraform.io/providers/integrations/github/6.3.1)
- [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.
## Features / Issues / Bugs
Please report bugs and issues to the [CDK for Terraform](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/projen/projen), which takes care of generating the entire repository.
### cdktf-provider-project based on Projen
There's a custom [project builder](https://github.com/cdktf/cdktf-provider-project) which encapsulate the common settings for all `cdktf` prebuilt providers.
### Provider Version
The provider version can be adjusted in [./.projenrc.js](./.projenrc.js).
### Repository Management
The repository is managed by [CDKTF Repository Manager](https://github.com/cdktf/cdktf-repository-manager/).