Octokit 0.25.0

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

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

Release Notes

Advisories and Breaking Changes

- Octokit.net has been ported to dotnetcore 🎉 providing libraries targetting netstandard1.1 and net45 frameworks

- Enum fields in Octokit response classes are now wrapped in an StringEnum<TEnum> helper class, to provide more robustness in dealing with unknown API values for these fields. Whilst the changes are backwards compatible, please consult the guidance on working with Enums for more information

- IncludeAdmins field is no longer present in BranchProtectionRequiredStatusChecks and BranchProtectionRequiredStatusChecksUpdate classes, instead use the new EnforceAdmins field on BranchProtectionSettingsUpdate or the new explicit methods for configuring Admin Enforcement on protected branches. This was an upstream API breaking change so we couldn't follow our normal deprecation schedule

Release Notes

Milestone: CAKE Builds

Features/Enhancements

- Add a build task to validate LINQPad samples - #1551 via @mderriey
- Add a code formatting task to CAKE - #1550 via @mderriey
- Add GitVersion configuration file - #1555 via @mderriey

Milestone: dotnetcore Support

Features/Enhancements

- Port to .NET Core - #1503 via @mderriey, @ryangribble
- Remove unneeded files for .NET Core - #1549 via @mderriey
- Migrate dotnetcore to vs2017 tooling - #1567 via @ryangribble, @mderriey
- Provide SourceLink capability for Octokit and Octokit.Reactive assemblies - #1574 via @ryangribble, @mderriey
- Deliver the dotnetcore port and CAKE build framework changes - #1581 via @ryangribble, @mderriey

Fixes

- Fix broken JSON deserialization in .NET 4.5 after VS2017 project update - #1647 via @mderriey

Milestone: None

Features/Enhancements

- Add support for the newly resurrected PullRequest.MergeCommitSha property - #1562 via @alexperovich
- Enhance RepositoryBranchesClient to support Admin Enforcement changes - #1598 via @M-Zuber
- Implement Pull Request Review Requests API (Preview) - #1588 via @gdziadkiewicz, @ryangribble
- Provide a robust way to handle unknown enum values returned by GitHub API, to prevent deserialization errors until the enum values can be added to octokit - #1595 via @khellang, @ryangribble
- Implement Projects API (Preview) - #1480 via @maddin2016, @ryangribble
- Implement ReviewPermission() functionality for OrganizationMembersClient (Preview API) - #1633 via @alfhenrik
- Implement Organization OutsideCollaborators API (Preview) - #1639 via @alfhenrik, @ryangribble
- Implement pagination support for OrganizationOutsideCollaboratorsClient.GetAll() method - #1650 via @ryangribble
- Implement GetAllPendingInvitations() functionality for OrganizationMembersClient and TeamsClient (Preview API) - #1640 via @alfhenrik, @ryangribble
- Implement Pull Request Reviews API - #1648 via @hartra344, @ryangribble

Fixes

- Fix RepositoryTrafficClient to handle upstream API change in timestamps from Unix epoch time to ISO8601 - #1560 via @mderriey, @ryangribble
- Fix more IssueTimelineClient deserialization exceptions by adding more new EventInfoState values - #1563 via @ryangribble
- Fix NotificationsClient.MarkAsRead() exception by specifying a payload body in the PUT request - #1579 via @shiftkey, @ryangribble
- Fix connection.GetLastApiInfo() was returning null in some situations - #1580 via @ryangribble
- Fix even more IssueTimelineClient deserialization exceptions by adding even more new EventInfoState values (this is getting old!) - #1591 via @lynnfaraday, @ryangribble
- NewRepositoryWebHook.ToRequest() no longer discards existing fields if they are set - #1623 via @ctolkien
- Fix pagination on API calls that use Uri parameters (typically for requests that include some form of filtering) - #1649 via @ryangribble
- Fixed RepositoryCommitsClient.GetSha1() to correctly obtain the sha1 of the specified commit, after the API went from preview to official - #1654 via @ryangribble

Housekeeping

- Remove obsolete constructor of RepositoryUpdate request class - #1569 via @eriawan
- Remove unused Rx-Main dependency from LINQPad samples - #1593 via @NickCraver
- Change response models 'Url' properties from Uri to string - #1585 via @mderriey
- Remove obsolete branch protection methods/classes - #1620 via @ryangribble
- Remove methods and members that were marked [Obsolete] in 0.23 or earlier - #1622 via @ryangribble

Documentation Updates

- Fix Issue documentation samples (GetForRepository() should be GetForRepository()) - #1602 via @tnaoto
- Fix Release documentation samples (ReleaseUpdate should be NewRelease) - #1611 via @watsonlu

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 269,073 9/9/2018
0.31.0 88,223 7/21/2018
0.30.0 45,978 6/17/2018
0.29.0 265,773 2/18/2018
0.28.0 68,915 11/6/2017
0.27.0 25,121 10/7/2017
0.26.0 420,952 8/31/2017
0.25.0 20,502 8/23/2017
0.24.1-alpha0001 21,662 1/21/2017
0.24.0 124,284 1/17/2017
0.23.0 51,489 10/7/2016
0.22.0 14,560 9/1/2016
0.21.1 68,085 7/29/2016
0.21.0 7,431 7/28/2016
0.20.0 27,794 6/14/2016
0.19.0 103,564 3/13/2016
0.18.0 94,699 2/2/2016
0.17.0 27,541 12/8/2015
0.16.0 43,905 9/17/2015
0.15.0 8,341 9/10/2015
0.14.0 18,517 7/18/2015
0.13.0 21,531 6/17/2015
0.12.0 9,254 5/19/2015
0.11.0 6,932 5/9/2015
0.10.0 23,462 4/22/2015
0.9.0 9,405 4/6/2015
0.8.0 8,490 3/19/2015
0.7.3 6,621 3/9/2015
0.7.2 9,457 3/1/2015
0.7.1 7,209 2/24/2015
0.7.0 7,237 2/23/2015
0.7.0-alpha2 5,614 2/19/2015
0.7.0-alpha 5,703 2/19/2015
0.6.2 11,654 1/5/2015
0.6.1 6,329 12/23/2014
0.6.0 5,996 12/11/2014
0.5.3 5,654 12/10/2014
0.5.2 14,606 10/14/2014
0.5.1 6,284 10/7/2014
0.5.0 5,383 10/7/2014
0.4.1 25,605 7/22/2014
0.4.0 5,891 7/11/2014
0.3.5 5,648 6/30/2014
0.3.4 11,330 4/30/2014
0.3.3 7,520 4/24/2014
0.3.2 5,408 4/17/2014
0.3.1 5,864 3/31/2014
0.3.0 5,519 3/19/2014
0.2.2 5,365 3/6/2014
0.2.1 5,129 2/20/2014
0.2.0 5,019 2/20/2014
0.1.9 5,023 2/20/2014
0.1.8 4,963 1/22/2014
0.1.7 4,473 12/27/2013
0.1.6 4,101 12/26/2013
0.1.5 4,183 11/19/2013
0.1.4 3,801 11/7/2013
0.1.3 3,633 11/6/2013
0.1.1 3,344 10/30/2013
0.1.0 3,385 10/30/2013
Show less