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

Version History

Version Downloads Last updated
0.32.0 61,183 9/9/2018
0.31.0 40,995 7/21/2018
0.30.0 38,168 6/17/2018
0.29.0 216,282 2/18/2018
0.28.0 59,884 11/6/2017
0.27.0 19,647 10/7/2017
0.26.0 414,989 8/31/2017
0.25.0 16,559 8/23/2017
0.24.1-alpha0001 16,541 1/21/2017
0.24.0 112,001 1/17/2017
0.23.0 44,890 10/7/2016
0.22.0 10,816 9/1/2016
0.21.1 63,900 7/29/2016
0.21.0 4,043 7/28/2016
0.20.0 24,370 6/14/2016
0.19.0 96,121 3/13/2016
0.18.0 91,336 2/2/2016
0.17.0 23,216 12/8/2015
0.16.0 33,456 9/17/2015
0.15.0 5,341 9/10/2015
0.14.0 15,206 7/18/2015
0.13.0 12,973 6/17/2015
0.12.0 6,401 5/19/2015
0.11.0 4,129 5/9/2015
0.10.0 19,733 4/22/2015
0.9.0 6,613 4/6/2015
0.8.0 5,797 3/19/2015
0.7.3 4,008 3/9/2015
0.7.2 6,833 3/1/2015
0.7.1 4,624 2/24/2015
0.7.0 4,620 2/23/2015
0.7.0-alpha2 3,097 2/19/2015
0.7.0-alpha 3,138 2/19/2015
0.6.2 9,053 1/5/2015
0.6.1 3,818 12/23/2014
0.6.0 3,510 12/11/2014
0.5.3 3,180 12/10/2014
0.5.2 11,112 10/14/2014
0.5.1 3,868 10/7/2014
0.5.0 2,972 10/7/2014
0.4.1 16,190 7/22/2014
0.4.0 3,479 7/11/2014
0.3.5 3,320 6/30/2014
0.3.4 6,681 4/30/2014
0.3.3 5,168 4/24/2014
0.3.2 3,093 4/17/2014
0.3.1 3,556 3/31/2014
0.3.0 3,237 3/19/2014
0.2.2 3,093 3/6/2014
0.2.1 3,009 2/20/2014
0.2.0 2,917 2/20/2014
0.1.9 2,935 2/20/2014
0.1.8 3,238 1/22/2014
0.1.7 2,853 12/27/2013
0.1.6 2,628 12/26/2013
0.1.5 2,800 11/19/2013
0.1.4 2,613 11/7/2013
0.1.3 2,494 11/6/2013
0.1.1 2,397 10/30/2013
0.1.0 2,451 10/30/2013