Octokit.net Documentation

Octokit is compatible with the following environments:

• .NET 4.6.1 (Desktop / Server) or greater
• .NET Standard 2.0 or greater

To access private repositories or perform actions on behalf of a user, assign Credentials to the GitHubClient.Credentials property. You can use a Personal Access Token (PAT), an OAuth access token, or an installation token from a GitHub App.

var tokenAuth = new Credentials("token"); // This can be a PAT or an OAuth token.
client.Credentials = tokenAuth;

Once Enable source server support is active in Visual Studio, you can debug Octokit internals directly:

1. Set a breakpoint in your own application code where you call Octokit.
2. When the breakpoint is hit, use F11 (Step Into) to enter the Octokit source code.
3. Visual Studio will automatically retrieve the source file associated with the specific type and cache it in your local symbols cache.
4. You can then set subsequent breakpoints within the retrieved Octokit source code to continue your debugging session.

To connect to a GitHub Enterprise instance, pass the enterprise server URL as a Uri to the GitHubClient constructor.

var ghe = new Uri("https://github.myenterprise.com/");
var client = new GitHubClient(new ProductHeaderValue("my-cool-app"), ghe);

To use Octokit, instantiate a GitHubClient. You must provide a ProductHeaderValue which populates the User-Agent header. GitHub requires this header to identify the application making the request. Using an unauthenticated client allows access to public APIs but is subject to lower rate limits.

var client = new GitHubClient(new ProductHeaderValue("my-cool-app"));

To create a branch, you must create a NewReference object and then use the Reference.Create API.

Requirements for the reference name:

• It must start with refs/.
• It must contain two / characters (e.g., refs/heads/branch-name).

Requirements for the commit SHA:

• The SHA must correspond to an existing commit in the repository.

// 1. Define the new reference
var reference = new NewReference($"refs/heads/{branchName}", commit.Sha);

// 2. Create the reference using either owner/repo name or repository ID
var branch = await github.Git.Reference.Create(owner, repo, reference);
// OR
var branch = await github.Git.Reference.Create(id, reference);

To initiate authentication, use OauthLoginRequest to define the required permissions (Scopes) and a State value to prevent CSRF attacks. Use client.Oauth.GetGitHubLoginUrl(request) to generate the URL that the user must be navigated to.

If you do not specify Scopes, the application will only have read access to the user's public data. You can also specify a custom RedirectUri within the request.

Octokit provides support for GitHub Enterprise administration APIs to script administrative tasks. To use these APIs, you must initialize the GitHubClient with the enterprise instance URI and ensure your credentials have the site_admin scope. Only administrators of the GitHub Enterprise instance can access these endpoints.

var enterprise = new Uri("https://github.myenterprise.com/");
var github = new GitHubClient("some app name", enterprise);
gitHub.Credentials = new Credentials("some-token-here");

var stats = await github.Enterprise.AdminStats.GetStatisticsUsers();
Console.WriteLine($"Found {stats.AdminUsers} admins, {stats.TotalUsers} total users and {stats.SuspendedUsers} suspended users");

To use a proxy with Octokit, you must manually construct the Connection using an HttpClientAdapter that utilizes a custom HttpMessageHandler. This is achieved by passing a factory method to the adapter that calls HttpMessageHandlerFactory.CreateDefault(proxy).

Note: GitHub Enterprise support with a custom proxy is currently broken. Auto-wiring of proxy details at runtime is not yet supported.

// set your proxy details here
var proxy = new WebProxy(); 

// this is the core connection
var connection = new Connection(new ProductHeaderValue("my-cool-app"),
    new HttpClientAdapter(() => HttpMessageHandlerFactory.CreateDefault(proxy)));

// and pass this connection to your client
var client = new GitHubClient(connection);