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

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