Skip to content

Commit

Permalink
make it clearer that a test account is a good idea
Browse files Browse the repository at this point in the history
  • Loading branch information
shiftkey committed Dec 11, 2014
1 parent fdaa9df commit f819647
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,16 @@ Run this command to confirm all the tests pass: `.\build`
### Running integration tests

Octokit has integration tests that access the GitHub API, but they must be
configured before they will be executed. To configure the tests, create a
test GitHub account (i.e., don't use your real GitHub account) and a test
organization owned by that account. Then set the following environment variables:
configured before they will be executed.

**Note:** To run the tests, we highly recommend you create a test GitHub
account (i.e., don't use your real GitHub account) and a test organization
owned by that account. Then set the following environment variables:

`OCTOKIT_GITHUBUSERNAME` (set this to the test account's username)
`OCTOKIT_GITHUBPASSWORD` (set this to the test account's password)
`OCTOKIT_GITHUBORGANIZATION` (set this to the test account's organization)


Once these are set, the integration tests will be executed both when
running the FullBuild MSBuild target, and when running the
Octokit.Tests.Integration assembly through an xUnit.net-friendly test runner.
Expand Down

0 comments on commit f819647

Please sign in to comment.