Octokit 0.18.0

An async-based GitHub API client library for .NET

There is a newer version of this package available.
See the version list below for details.
Install-Package Octokit -Version 0.18.0
dotnet add package Octokit --version 0.18.0
<PackageReference Include="Octokit" Version="0.18.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Octokit --version 0.18.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

  • .NETCore 4.5

    • No dependencies.
  • .NETFramework 4.5

    • No dependencies.
  • All Frameworks

  • Portable Class Library (Windows 8.1, WindowsPhoneApp 8.1)

    • No dependencies.

NuGet packages (66)

Showing the top 5 NuGet packages that depend on Octokit:

Package Downloads
Nuke.Common
Cross-platform build automation system
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#.
Octokit.Reactive
An IObservable based GitHub API client library for .NET and .NET Core using Reactive Extensions
FluffySpoon.Publisher
Publishes NPM or NuGet packages automatically.
Wyam.GitHub
Wyam is a simple to use, highly modular, and extremely configurable static content generator. This library contains modules for interacting with GitHub.

GitHub repositories (77)

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

Repository Stars
CodeHubApp/CodeHub
CodeHub is an iOS application written using Xamarin
dotnet/BenchmarkDotNet
Powerful .NET library for benchmarking
abpframework/abp
Open Source Web Application Framework for ASP.NET Core
OptiKey/OptiKey
OptiKey - Full computer control and speech with your eyes
AngleSharp/AngleSharp
:angel: The ultimate angle brackets parser library parsing HTML5, MathML, SVG and CSS to construct a DOM based on the official W3C specifications.

Version History

Version Downloads Last updated
0.48.0 98,680 6/7/2020
0.47.0 112,590 4/12/2020
0.46.0 91,061 3/26/2020
0.45.0 5,373 3/17/2020
0.44.0 6,210 3/15/2020
0.43.0 21,062 3/2/2020
0.42.0 7,009 2/26/2020
0.41.0 766 2/24/2020
0.40.0 45,805 2/10/2020
0.39.0 215 2/9/2020
0.38.0 416 2/8/2020
0.37.0 4,795 2/3/2020
0.36.0 536,590 10/8/2019
0.35.0 3,809 10/1/2019
0.34.0 7,517 9/17/2019
0.33.0 8,416 9/12/2019
0.32.0 616,823 9/9/2018
0.31.0 173,954 7/21/2018
0.30.0 48,187 6/17/2018
0.29.0 333,366 2/18/2018
0.28.0 81,463 11/6/2017
0.27.0 30,262 10/7/2017
0.26.0 427,263 8/31/2017
0.25.0 22,205 8/23/2017
0.24.1-alpha0001 25,944 1/21/2017
0.24.0 138,005 1/17/2017
0.23.0 58,717 10/7/2016
0.22.0 15,986 9/1/2016
0.21.1 69,513 7/29/2016
0.21.0 8,552 7/28/2016
0.20.0 29,272 6/14/2016
0.19.0 110,311 3/13/2016
0.18.0 95,839 2/2/2016
0.17.0 30,909 12/8/2015
0.16.0 45,607 9/17/2015
0.15.0 9,463 9/10/2015
0.14.0 20,377 7/18/2015
0.13.0 25,840 6/17/2015
0.12.0 10,144 5/19/2015
0.11.0 7,793 5/9/2015
0.10.0 26,818 4/22/2015
0.9.0 10,566 4/6/2015
0.8.0 9,355 3/19/2015
0.7.3 7,374 3/9/2015
0.7.2 10,298 3/1/2015
0.7.1 8,035 2/24/2015
0.7.0 8,113 2/23/2015
0.7.0-alpha2 6,364 2/19/2015
0.7.0-alpha 6,460 2/19/2015
0.6.2 12,473 1/5/2015
0.6.1 7,046 12/23/2014
0.6.0 6,728 12/11/2014
0.5.3 6,391 12/10/2014
0.5.2 18,019 10/14/2014
0.5.1 7,008 10/7/2014
0.5.0 6,092 10/7/2014
0.4.1 47,950 7/22/2014
0.4.0 6,677 7/11/2014
0.3.5 6,400 6/30/2014
0.3.4 17,176 4/30/2014
0.3.3 8,204 4/24/2014
0.3.2 6,057 4/17/2014
0.3.1 6,531 3/31/2014
0.3.0 6,186 3/19/2014
0.2.2 6,021 3/6/2014
0.2.1 5,682 2/20/2014
0.2.0 5,578 2/20/2014
0.1.9 5,615 2/20/2014
0.1.8 5,386 1/22/2014
0.1.7 4,933 12/27/2013
0.1.6 4,442 12/26/2013
0.1.5 4,494 11/19/2013
0.1.4 4,137 11/7/2013
0.1.3 3,920 11/6/2013
0.1.1 3,899 10/30/2013
0.1.0 3,708 10/30/2013
Show less