Building The Provider
Clone repository to:
$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers $ git clone firstname.lastname@example.org:terraform-providers/terraform-provider-github.git
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-github $ make build # or if you're on a mac: $ gnumake build
Using the provider
Detailed documentation for the GitHub provider can be found here.
Developing the Provider
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ is required). You'll also need to correctly setup a GOPATH, as well as adding
$GOPATH/bin to your
To compile the provider, run
make build. This will build the provider and put the provider binary in the
$ make build ... $ $GOPATH/bin/terraform-provider-github ...
In order to test the provider, you can simply run
$ make test
In order to run the full suite of Acceptance tests, run
Note: Acceptance tests create real resources, and often cost money to run.
$ make testacc
Acceptance test prerequisites
In order to successfully run the full suite of acceptance tests, you will need to have the following:
GitHub personal access token
You will need to create a personal access token for testing. It will need to have the following scopes selected:
Once the token has been created, it must be exported in your environment as
If you do not have an organization already that you are comfortable running tests against, you will need to create one. The free "Team for Open Source" org type is fine for these tests. The name of the
organization must then be exported in your environment as
In the organization you are using above, create the following test repositories:
- The description should be
Test description, used in GitHub Terraform provider acceptance test.
- The website url should be
- Create two topics within the repo named
- In the repo settings, make sure all features and merge button options are enabled.
- Create a
- The description should be
- Configure the repository to be a Template repository
- Create a release on the repository with
tag = v1.0
Export an environment variable corresponding to
Export your github username (the one you used to create the personal access token above) as
GITHUB_TEST_USER. You will need to export a
different github username as
GITHUB_TEST_COLLABORATOR. Please note that these usernames cannot be the same as each other, and both of them
must be real github usernames. The collaborator user does not need to be added as a collaborator to your test repo or organization, but as
the acceptance tests do real things (and will trigger some notifications for this user), you should probably make sure the person you specify
knows that you're doing this just to be nice. You can also export
GITHUB_TEST_COLLABORATOR_TOKEN in order to test the invitation acceptance.
Additionally the user exported as
GITHUB_TEST_USER should have a public email address configured in their profile; this should be exported
GITHUB_TEST_USER_EMAIL and the Github name exported as
GITHUB_TEST_USER_NAME (this could be different to your GitHub login).
Finally, export the ID of the release created in the template repository as