Octokit 0.20.0

An async-based GitHub API client library for .NET

Install-Package Octokit -Version 0.20.0

dotnet add package Octokit --version 0.20.0

<PackageReference Include="Octokit" Version="0.20.0" />

paket add Octokit --version 0.20.0

#r "nuget: Octokit, 0.20.0"

// Install Octokit as a Cake Addin
#addin nuget:?package=Octokit&version=0.20.0

// Install Octokit as a Cake Tool
#tool nuget:?package=Octokit&version=0.20.0

Release Notes

Features**
The big focus for this release is pagination support. This lets the caller
control how much data to retrieve for `GetAll*` endpoints throughout Octokit.
This was a team effort to apply this across the entire codebase, with
contributions from @dampir, @devkhan, @prayankmathur, @SamTheDev and @shiftkey.
For more information about how to use pagination in your projects refer to the
documentation: http://octokitnet.readthedocs.io/en/latest/extensibility/#pagination
- Add Migrations preview API - #1141 via @devkhan
- Add Issue Lock/Unlock functionality - #1185 via @prayankmathur
- Added Commit Reference SHA-1 API - #1195 via @ryangribble
- Add additional parameters to `SearchIssuesRequest` -  #1228 via @ryangribble
- Add `Importer` property to Meta endpoint - #1235 via @ryangribble
- Raise HTTP 451 exception when repository has DMCA notice - #1239 via @devkhan
- Add Merge and Squash preview API - #1245 via @Sarmad93
- Add additional methods to `IEventsClient` - #1288 via @drasticactions
- Add Organization Permissions preview API - #1342 via @ryangribble
- Add GPG Keys preview API - #1343 via @alfhenrik
Fixes**
- Renamed `IUserKeysClient.GetAll()` to `IUserKeysClient.GetAllForCurrent()` - #1139 via @M-Zuber
- Add `ItemStateFilter` enum to differentiate between search and list endpoints - #1140 via @prayankmathur
- `RepositoriesClient.GetAllPublic()` fails for Enterprise instanes due to URI structure - #1204 via @ryangribble
- `ConfigureAwait(false)` usages added, eliminating deadlocks - #1248 via @shiftkey
- Renamed `CompareResult.MergedBaseCommit` to fix serialization issue - #1265 via @kivancmuslu
- Activity Feed now returns issues and repository events - #1288 via @drasticactions
- Add `Repository` property to `Issue` response - #1292 via @M-Zuber
- `SearchCodeRequest` now supports searching without specifying a term - #1338 via @dsplaisted
- Add required Permission parameter to team management APIs - #1347 via @ryangribble
- Add `ClosedBy` property to `Issue` - #1353 via @maddin2016
Other**
- Deleting now-obsolete code - #1224 via @M-Zuber
- Centralize and cleanup the `Uri`s created in Octokit - #1287, #1290 via @dampir
- Updated documentation links - #1289 via @radu-matei, #1250 via @SamTheDev
Breaking Changes**
- `IUserKeysClient.GetAll()` was named incorrectly when it was originally implemented
and only works for the current user's keys. Update all usages to `GetAllForCurrent()`.
- `CompareResult.MergedBaseCommit` was never deserialized correctly, and has
been marked as obsolete. You should use `CompareResult.MergeBaseCommit`
instead (note the lack of a `d`).
- `IEventsClient.GetAllForRepository` was incorrectly retrieving issue
events before this release. Use the new `IEventsClient.GetAllIssuesForRepository`
method if you still require issues, or continue to use `IEventsClient.GetAllForRepository`
if you require all repository events.
- `IUsersClient` has a property named `Keys` which has been renamed in the
GitHub API documentation - Octokit has added the name `GitSshKey` to
reflect this change, and `Keys` will be removed in a later release.

Dependencies

• .NETCore 4.5

  • No dependencies.

• .NETFramework 4.5

  • No dependencies.

• All Frameworks

  • Microsoft.Net.Http

• Portable Class Library (Windows 8.1, WindowsPhoneApp 8.1)

  • No dependencies.

Used By

NuGet packages (77)

Showing the top 5 NuGet packages that depend on Octokit:

Package	Downloads
Nuke.Common Cross-platform build automation system Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit 'eec1cad386b573457c42795e4c3ceed36a84cd30' (see contained AppVeyorSettings.json file for build settings).	1.6M
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#.	140.8K
Octokit.Reactive An IObservable based GitHub API client library for .NET and .NET Core using Reactive Extensions	128.6K
FluffySpoon.Publisher Publishes NPM or NuGet packages automatically.	63.5K
Wyam.GitHub Wyam is a simple to use, highly modular, and extremely configurable static content generator. This library contains modules for interacting with GitHub.	36.6K

GitHub repositories (91)

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

Repository	Stars
CodeHubApp/CodeHub CodeHub is an iOS application written using Xamarin	23.3K
dotnet/BenchmarkDotNet Powerful .NET library for benchmarking	6.6K
abpframework/abp Open Source Web Application Framework for ASP.NET Core	6.3K
rocksdanister/lively Free and open-source software that allows users to set animated desktop wallpapers and screensavers.	4.1K
OptiKey/OptiKey OptiKey - Full computer control and speech with your eyes	3.8K

Version History