zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-05 23:06:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

make it clearer that a test account is a good idea

Browse Source
This commit is contained in:
Brendan Forster
2014-12-11 15:23:49 +10:30
parent fdaa9df55a
commit f819647329
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@@ -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.