Octokit 0.18.0

An async-based GitHub API client library for .NET

Install-Package Octokit -Version 0.18.0

dotnet add package Octokit --version 0.18.0

<PackageReference Include="Octokit" Version="0.18.0" />

paket add Octokit --version 0.18.0

#r "nuget: Octokit, 0.18.0"

// Install Octokit as a Cake Addin
#addin nuget:?package=Octokit&version=0.18.0

// Install Octokit as a Cake Tool
#tool nuget:?package=Octokit&version=0.18.0

Release Notes

New: support for User Administration API (GitHub Enterprise) - #1068 via @paladique
New: support for Admin Stats API (GitHub Enterprise) - - #1049 via @ryangribble
New: support for Repository Pages API - #1061 via @M-Zuber
New: get stargazer creation timestamps - #1060 via @daveaglick
New: support for Protected Branches API - #996 via @ryangribble
New: support for creating Personal Access Tokens - #990 via @alfhenrik
Fixed: `Milestone` property added to `PullRequest` response - #1075 via @Eilon
Fixed: Add member role filter to `OrganizationMembersClient.GetAll()` - #1072 via @ryangribble
Fixed: `Repository.Content.GetAllContents` now support the root of the repository - #1064 via @naveensrinivasan, @shiftkey
Fixed: added `Id` and `Locked` to `Issue`, added `CommitUrl` to `IssueEvent` - #1039 via @gabrielweyer
Fixed: additional fields on `Release` and `ReleaseAsset` - #1009 via @gabrielweyer
Fixed: `ApiException` now includes JSON payload when `.ToString()`- #974 via @asizikov
Breaking Changes:**
As part of reaching 1.0 we went through to audit the current implementation
and identify areas that didn't align with our conventions. For this release,
we're marking the endpoints as `[Obsolete]` and indicating the new location.
These will be cleaned up in the next release:
- `IGitHubClient.Notifications` -> `IGitHubClient.Activity.Notifications` - #1019 via @M-Zuber
- `IGitHubClient.Repository.CommitStatus` -> `IGitHubClient.Repository.Status` - #1043 via @RobPethick
- `IGitHubClient.Repository.Commits` -> `IGitHubClient.Repository.Commit` - #1057 via @M-Zuber
- `IGitHubClient.Repository.RepoCollaborators` -> `IGitHubClient.Repository.Collaborator` - #1040 via @M-Zuber
- `IGitHubClient.Repository.RepositoryComments` -> `IGitHubClient.Repository.Comment` - #1044 via @M-Zuber
- `IGitHubClient.Release` -> `IGitHubClient.Repository.Release` - #1058 via @RobPethick
- `IGitHubClient.GitDatabase` -> `IGitHubClient.Git` - #1048 via @RobPethick
Other breaking changes:
- a public `ApiExtensions.Get<T>` extension method was causing a bunch of
tests to be written in a confusing way. This has been ported to an interface
method on `IApiConnection` but hopefully you're not referencing this method
externally - see #1063 for more information.
- `IRepositoryContentsClient.GetArchiveLink` is no longer correct, as the HTTP
behaviour in Octokit was updated to follow redirects received from the server.
See #986 for the last bits of cleanup.
- `IRepositoryContentsClient.GetAllContents(string owner, string name, string path, string reference)`
has been renamed to `GetAllContentsByRef(string owner, string name, string path, string reference)`
to prevent overlap with methods on `IRepositoryContentsClient` which do not
specify a path - and thus look at the root of the repository.
- `IssueEventPayload` has two fields which are never populated from the API -
`Assignee` and `Label` - these are now removed. You should use
`Issue.Assignee` and `Issue.Labels` instead. See #1039 for more details.
- `PullRequest.MergeCommitSha` is marked as obsolete by the GitHub API - we
are cleaning up the behaviour for determining whether a PR has been
merged in #997 - see the PR for more information.
- `IAuthorizationsClient.RevokeAllApplicationAuthentications` is no longer
available through the GitHub API - this will be removed in the next
release.
Shout outs**
A lot of extra work went into this release, and I wanted to thank those people
who helped out - without their efforts we wouldn't be at this point:
- @naveensrinivasan - for helping set up our Travis CI builds to test this on
Mono - see #995 for the details
- @hahmed - for contributing a bunch of documentation around the Octokit search
APIs - see #955, #954 and #951
- @JakesCode - for clarifying some documentation after he reported an issue - #1054
- @ryangribble - for helping get our GitHub Enterprise testing off the ground - #987
- @naveensrinivasan - for catching and addressing an issue with our LINQPad snippets - #987

Dependencies

• .NETCore 4.5

  • No dependencies.

• .NETFramework 4.5

  • No dependencies.

• All Frameworks

  • Microsoft.Net.Http

• Portable Class Library (Windows 8.1, WindowsPhoneApp 8.1)

  • No dependencies.

Used By

NuGet packages (77)

Showing the top 5 NuGet packages that depend on Octokit:

Package	Downloads
Nuke.Common Cross-platform build automation system Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit 'eec1cad386b573457c42795e4c3ceed36a84cd30' (see contained AppVeyorSettings.json file for build settings).	1.6M
Fake.Api.GitHub FAKE - F# Make - is a build automation tool for .NET. Tasks and dependencies are specified in a DSL which is integrated in F#.	140.8K
Octokit.Reactive An IObservable based GitHub API client library for .NET and .NET Core using Reactive Extensions	128.6K
FluffySpoon.Publisher Publishes NPM or NuGet packages automatically.	63.5K
Wyam.GitHub Wyam is a simple to use, highly modular, and extremely configurable static content generator. This library contains modules for interacting with GitHub.	36.6K

GitHub repositories (91)

Showing the top 5 popular GitHub repositories that depend on Octokit:

Repository	Stars
CodeHubApp/CodeHub CodeHub is an iOS application written using Xamarin	23.3K
dotnet/BenchmarkDotNet Powerful .NET library for benchmarking	6.6K
abpframework/abp Open Source Web Application Framework for ASP.NET Core	6.3K
rocksdanister/lively Free and open-source software that allows users to set animated desktop wallpapers and screensavers.	4.1K
OptiKey/OptiKey OptiKey - Full computer control and speech with your eyes	3.8K

Version History