Github Provider: Installation & Configuration

The Pulumi GitHub provider uses the GitHub SDK to manage and provision resources.

Installation

The GitHub provider is available as a package in all Pulumi languages:

• JavaScript/TypeScript: @pulumi/github
• Python: pulumi-github
• Go: github.com/pulumi/pulumi-github/sdk/v4/go/github
• .NET: Pulumi.Github
• Java: com.pulumi/github

Configuring Credentials

Pulumi relies on the GitHub SDK to authenticate requests from your computer to GitHub. Your credentials are never sent to pulumi.com. The Pulumi GitHub Provider needs to be configured with GitHub credentials before it can be used to create resources.

Once the credentials are obtained, there are two ways to communicate your authorization tokens to Pulumi:

1. Set the environment variable GITHUB_TOKEN.

   $ export GITHUB_TOKEN=YYYYYYYYYYYYYY
   

2. Set the token value using pulumi config. This stores your token alongside your Pulumi stack for easy multi-user access.

   $ pulumi config set github:token XXXXXXXXXXXXXX --secret
   

3. (Optional) To target a specific GitHub organization or an individual user account, set the GitHub owner configuration value. If this is not provided, the owner of the GitHub Access Token will be the target of the provider.

   $ export GITHUB_OWNER=YYYYYYYYYYYYYY
   

   $ pulumi config set github:owner YYYYYYYYYYYYYY
   

The complete list of configuration parameters is in the GitHub provider README.