Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Intro to Pulumi
  3. Cloud Providers
  4. GitHub
  5. GitHub Setup

GitHub Setup

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

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.

Configuring Credentials

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

  1. Set the environment variable GITHUB_TOKEN:

    $ export GITHUB_TOKEN=XXXXXXXXXXXXXX

  2. Set them using configuration, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:

    $ pulumi config set github:token XXXXXXXXXXXXXX --secret

Remember to pass --secret when setting github:token so that it is properly encrypted. A full set of configuration parameters can be found listed on the Project README.