The GitHub resource provider for Pulumi lets you use GitHub resources in your infrastructure programs. To use this package, please install the Pulumi CLI first.
This package is available in many languages in the standard packaging formats.
$ npm install @pulumi/github
$ yarn add @pulumi/github
To use from Python, install using
$ pip install pulumi-github
To use from Go, use
go get to grab the latest version of the library
$ go get github.com/pulumi/pulumi-github/sdk/v3/go/...
To use from .NET, install using
dotnet add package:
$ dotnet add package Pulumi.Github
The following configuration points are available:
github:token- (Optional) This is the GitHub personal access token. It can also be sourced from the
GITHUB_TOKENenvironment variable. If anonymous is false, token is required.
github:organization- (Optional) This is the target GitHub organization to manage. The account corresponding to the token will need "owner" privileges for this organization. It can also be sourced from the
GITHUB_ORGANIZATIONenvironment variable. If individual is set to false, organization is required.
github:baseUrl- (Optional) This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the
GITHUB_BASE_URLenvironment variable. The value must end with a slash, and generally includes the API version, for instance
github:insecure- (Optional) Whether server should be accessed without verifying the TLS certificate. As the name suggests this is insecure and should not be used beyond experiments, accessing local (non-production) GHE instance etc. There is a number of ways to obtain trusted certificate for free, e.g. from Let's Encrypt. Such trusted certificate does not require this option to be enabled. Defaults to
github:individual- (Optional) Run outside an organization. When individual is true, the provider will run outside the scope of an organization. Defaults to
github:anonymous- (Optional) Authenticate without a token. When anonymous is true, the provider will not be able to access resources that require authentication. Setting to true will lead the GitHub provider to work in an anonymous mode with the corresponding API rate limits. Defaults to