Octokit 0.30.0

An async-based GitHub API client library for .NET and .NET Core

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

Advisories and Breaking Changes

  • Note that the IssuesLabelsClient.RemoveFromIssue() methods which previously had no return value, will now return an IReadonlyList&lt;Label&gt;. This change is source compatible but not binary compatible.
  • The following [Obsolete] items have been removed from octokit, please use the indicated replacements:

Client Methods

  • OranizationsClient.GetAll() => GetAllForUser()
  • PullRequestsClient.Comment => ReviewComment
  • RepositoryBranchesClient.GetRequiredStatusChecksContexts() => GetAllRequiredStatusChecksContexts()
  • RepositoryBranchesClient.GetProtectedBranchTeamRestrictions() => GetAllProtectedBranchTeamRestrictions()
  • RepositoryBranchesClient.GetProtectedBranchUserRestrictions() => GetAllProtectedBranchUserRestrictions()
  • RepositoryTrafficClient.GetReferrers() => GetAllReferrers()
  • RepositoryTrafficClient.GetPaths() => GetAllPaths()
  • TeamsClient.GetMembership() => GetMembershipDetails()
  • TeamsClient.AddMembership() => AddOrEditMembership()
  • TeamsClient.AddMembership() => AddOrEditMembership()

Request Models

  • Remove unwanted ctor's from BranchProtectionUpdateSettings and UpdateTeam
  • NewIssue Assignee => Assignees
  • IssueUpdate Assignee => Assignees

Response Models

  • TeamMembership => TeamMembershipDetails

Release Notes

Milestone: GitHub Apps

Features/Enhancements

Milestone: None

Features/Enhancements

  • Added PreviousFileName field to PullRequestFile response - #1770 via @Kaneraz
  • Support PullRequestReviewEvent payloads using new response model PullRequestReviewEventPayload - #1767 via @Cyberboss
  • Add the ability to search issues by milestones, using SearchIssuesRequest.Milestone - #1788 via @mkArtak
  • Add an overload to IReleasesClient.Get() that allows retrieving a Release by the associated tag - #1793 via @tasadar2, @ryangribble
  • Add MaintainerCanModify field to PullRequest response and NewPullRequest and UpdatePullRequest requests - #1771 via @Cyberboss, @ryangribble
  • Enabled additional methods for preview "Nested Teams" support:
    • IRepositoriesClient.GetAllTeams()
    • IRepositoryBranchesClient.GetAllProtectedBranchTeamRestrictions()
    • IRepositoryBranchesClient.UpdateProtectedBranchTeamRestrictions()
    • IRepositoryBranchesClient.AddProtectedBranchTeamRestrictions()
    • IRepositoryBranchesClient.DeleteProtectedBranchTeamRestrictions() - #1795 via @MikhailTymchukDX, @ryangribble
  • Implement Pre Receive Environments API (Preview) for GitHub Enterprise - #1796 via @tasadar2, @ryangribble
  • Implement support for Label API Improvements, including additional fields (Description and Default), emoji support and searching for labels (SearchClient.SearchLabels()) - #1802 via @jozefizso, @ryangribble

Housekeeping

  • Correct missing/incorrect XmlDoc entries for parameters on some methods - #1779 via @ryangribble
  • Parameter names in validation exception messages are now derived from the parameters themselves, rather than a literal string that was hopefully kept up to date - #1781 via @itaibh
  • Update Octokit build tooling to use .NET SDK 2.x (note that this is only an SDK tooling update - Octokit and Octokit.Reactive libraries are still targeting netstandard1.1) - #1784 via @ryangribble
  • Removed a number of [Obsolete] methods, members and constructors inline with our standard deprecation schedule - #1780 via @ryangribble
  • Ensure all response models have appropriate ctor's to allow mocking, and enforce with a convention test - #1798 via @tasadar2, @ryangribble

Documentation Updates

Advisories and Breaking Changes

  • Note that the IssuesLabelsClient.RemoveFromIssue() methods which previously had no return value, will now return an IReadonlyList&lt;Label&gt;. This change is source compatible but not binary compatible.
  • The following [Obsolete] items have been removed from octokit, please use the indicated replacements:

Client Methods

  • OranizationsClient.GetAll() => GetAllForUser()
  • PullRequestsClient.Comment => ReviewComment
  • RepositoryBranchesClient.GetRequiredStatusChecksContexts() => GetAllRequiredStatusChecksContexts()
  • RepositoryBranchesClient.GetProtectedBranchTeamRestrictions() => GetAllProtectedBranchTeamRestrictions()
  • RepositoryBranchesClient.GetProtectedBranchUserRestrictions() => GetAllProtectedBranchUserRestrictions()
  • RepositoryTrafficClient.GetReferrers() => GetAllReferrers()
  • RepositoryTrafficClient.GetPaths() => GetAllPaths()
  • TeamsClient.GetMembership() => GetMembershipDetails()
  • TeamsClient.AddMembership() => AddOrEditMembership()
  • TeamsClient.AddMembership() => AddOrEditMembership()

Request Models

  • Remove unwanted ctor's from BranchProtectionUpdateSettings and UpdateTeam
  • NewIssue Assignee => Assignees
  • IssueUpdate Assignee => Assignees

Response Models

  • TeamMembership => TeamMembershipDetails

Release Notes

Milestone: GitHub Apps

Features/Enhancements

Milestone: None

Features/Enhancements

  • Added PreviousFileName field to PullRequestFile response - #1770 via @Kaneraz
  • Support PullRequestReviewEvent payloads using new response model PullRequestReviewEventPayload - #1767 via @Cyberboss
  • Add the ability to search issues by milestones, using SearchIssuesRequest.Milestone - #1788 via @mkArtak
  • Add an overload to IReleasesClient.Get() that allows retrieving a Release by the associated tag - #1793 via @tasadar2, @ryangribble
  • Add MaintainerCanModify field to PullRequest response and NewPullRequest and UpdatePullRequest requests - #1771 via @Cyberboss, @ryangribble
  • Enabled additional methods for preview "Nested Teams" support:
    • IRepositoriesClient.GetAllTeams()
    • IRepositoryBranchesClient.GetAllProtectedBranchTeamRestrictions()
    • IRepositoryBranchesClient.UpdateProtectedBranchTeamRestrictions()
    • IRepositoryBranchesClient.AddProtectedBranchTeamRestrictions()
    • IRepositoryBranchesClient.DeleteProtectedBranchTeamRestrictions() - #1795 via @MikhailTymchukDX, @ryangribble
  • Implement Pre Receive Environments API (Preview) for GitHub Enterprise - #1796 via @tasadar2, @ryangribble
  • Implement support for Label API Improvements, including additional fields (Description and Default), emoji support and searching for labels (SearchClient.SearchLabels()) - #1802 via @jozefizso, @ryangribble

Housekeeping

  • Correct missing/incorrect XmlDoc entries for parameters on some methods - #1779 via @ryangribble
  • Parameter names in validation exception messages are now derived from the parameters themselves, rather than a literal string that was hopefully kept up to date - #1781 via @itaibh
  • Update Octokit build tooling to use .NET SDK 2.x (note that this is only an SDK tooling update - Octokit and Octokit.Reactive libraries are still targeting netstandard1.1) - #1784 via @ryangribble
  • Removed a number of [Obsolete] methods, members and constructors inline with our standard deprecation schedule - #1780 via @ryangribble
  • Ensure all response models have appropriate ctor's to allow mocking, and enforce with a convention test - #1798 via @tasadar2, @ryangribble

Documentation Updates

Showing the top 10 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
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.
ferventdesert/Hawk
visualized crawler & ETL IDE written with C#/WPF
elastic/elasticsearch-net
Elasticsearch.Net & NEST
abpframework/abp
ABP vNext
reactjs/React.NET
.NET library for JSX compilation and server-side rendering of React components
tidusjar/Ombi
Want a Movie or TV Show on Plex or Emby? Use Ombi!
Azure/azure-powershell
Microsoft Azure PowerShell

Version History

Version Downloads Last updated
0.32.0 217,637 9/9/2018
0.31.0 74,493 7/21/2018
0.30.0 45,069 6/17/2018
0.29.0 258,403 2/18/2018
0.28.0 67,319 11/6/2017
0.27.0 24,193 10/7/2017
0.26.0 419,757 8/31/2017
0.25.0 19,731 8/23/2017
0.24.1-alpha0001 20,524 1/21/2017
0.24.0 122,140 1/17/2017
0.23.0 50,382 10/7/2016
0.22.0 13,573 9/1/2016
0.21.1 67,321 7/29/2016
0.21.0 6,704 7/28/2016
0.20.0 27,059 6/14/2016
0.19.0 101,770 3/13/2016
0.18.0 93,988 2/2/2016
0.17.0 26,683 12/8/2015
0.16.0 43,243 9/17/2015
0.15.0 7,684 9/10/2015
0.14.0 17,795 7/18/2015
0.13.0 19,888 6/17/2015
0.12.0 8,655 5/19/2015
0.11.0 6,334 5/9/2015
0.10.0 22,709 4/22/2015
0.9.0 8,831 4/6/2015
0.8.0 7,936 3/19/2015
0.7.3 6,085 3/9/2015
0.7.2 8,906 3/1/2015
0.7.1 6,662 2/24/2015
0.7.0 6,688 2/23/2015
0.7.0-alpha2 5,108 2/19/2015
0.7.0-alpha 5,173 2/19/2015
0.6.2 11,113 1/5/2015
0.6.1 5,797 12/23/2014
0.6.0 5,503 12/11/2014
0.5.3 5,144 12/10/2014
0.5.2 13,867 10/14/2014
0.5.1 5,820 10/7/2014
0.5.0 4,870 10/7/2014
0.4.1 23,980 7/22/2014
0.4.0 5,428 7/11/2014
0.3.5 5,198 6/30/2014
0.3.4 10,488 4/30/2014
0.3.3 7,027 4/24/2014
0.3.2 4,931 4/17/2014
0.3.1 5,397 3/31/2014
0.3.0 5,070 3/19/2014
0.2.2 4,924 3/6/2014
0.2.1 4,737 2/20/2014
0.2.0 4,639 2/20/2014
0.1.9 4,661 2/20/2014
0.1.8 4,660 1/22/2014
0.1.7 4,249 12/27/2013
0.1.6 3,893 12/26/2013
0.1.5 4,024 11/19/2013
0.1.4 3,699 11/7/2013
0.1.3 3,537 11/6/2013
0.1.1 3,244 10/30/2013
0.1.0 3,291 10/30/2013