A GitHub API client library for .NET
API METHOD CONTRACT CHANGE: In this release, the return type/exception implementation of AddCollaborator
has changed by fixing a failure with 201 status code when adding a collaborator - #2559 via @annchous
RE: Converts response model property accessors from protected to the more appropriate private for consistency - #2565 via @nickfloyd - in support of Generative SDKs
Features/Enhancements
Fixes
Housekeeping
Documentation Updates
Full Changelog: https://github.com/octokit/octokit.net/compare/v2.0.1...v3.0.0
Features/Enhancements
Housekeeping
Documentation Updates
In this release, we are dropping support for .NET 4.6. This needs to be done to move forward with the framework and innovate using the new APIs and assemblies.
Highlights from the issue description:
.NET Framework 4.6 (and 4.6.1) went out of support on April 26, 2022. Continuing to publish Octokit for this target adds a support burden.
.NET standard 2.0 covers .NET Framework 4.6.2 already.
Supporting a single target framework, .NET standard 2.0, would simplify maintenance of this project while supporting all target frameworks currently supported upstream.
For reference, these are the supported versions going forward
.NET implementation | Version support |
---|---|
.NET and .NET Core | 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0 |
.NET Framework | 4.6.1 2, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8 |
For more information see #2521 via @nickfloyd
Fixes
Housekeeping
Documentation Updates
With this release, all preview logic and header implementations have been removed. GitHub REST API previews were promoted in October 2021. With this change, the headers no longer need to be passed to the GitHub REST API. This means you will no longer need to manually pass in preview headers (for any reason) to benefit from the API changes behind the preview logic.
Features/Enhancements
Fixes
Housekeeping
Documentation Updates
GetAllForUser
method docs to make it clear that only public memberships are returned - #2487 via @timrogers
Breaking changes
Features/Enhancements
Housekeeping
Documentation Updates
Full Changelog: https://github.com/octokit/octokit.net/compare/v0.52.0...v1.0.0
Features/Enhancements
Housekeeping
Features/Enhancements
Housekeeping
master
branch in codebase - #2306 via @shiftkey
Swift
to the language type enum so that it can be used when searching for repositories - #2344 via @p-brito
Documentation Updates
master
moniker to main
- #2345 via @SeanKilleen
RepositoryRequest.Visibility
has been renamed from RepositoryVisibility
to RepositoryRequestVisibility
to avoid clashing with the response typeSystem.Reactive
has dropped support for net46
with their next major release (v5). I plan to bump the new minimum version to for Octokit
and Octokit.Reactive
to net472
to stay in sync in some future update. Please consider upgrading if you depend on a earlier version of .NET Framework than net472
.Features/Enhancements
Fixes
Deployment.Payload
by returning Dictionary<string,string>
- #2303 via @haacked
Housekeeping
SearchCodeRequest.Users
and SearchCodeRequest.Organizations
now expects an array of strings, as the underling API supports searching for multiple users or organizations.PullRequestCommit.Author
and PullRequestCommit.Commiter
properties is changed from Committer
to User
, please ensure serializing or deserializing this object in your code is not impacted by this change.Fixes
License
property added to repository search API - #2258 via @Dagizmo
HtmlUrl
property to team and project response models - #2249 via @colbylwilliams
DeleteBranchOnMerge
property to repository creation API, also included on response model - #2268 via @samcackett
Author
and Committer
properties on PullRequestCommit
are now of type User
, not Committer
- #2224 via @mmv
Organization
response - #2239 via @InRedikaWB
project
option to no
term for searching issues and pull requests - #2227 via @samhouts
Housekeeping
ConcurrentCache
previously marked as obsolete - #2202 via @shiftkey
Documentation Updates
main
branch - #2220 via @HannahKiekens
README
introduction to project - #2288 via @haacked
README
- #2280 via @eatdrinksleepcode
README
- #2279 via @iAmBipinPaul
Octokit 0.48.0
on NuGet
Octokit.Reactive 0.48.0
on NuGet
Features/Enhancements
ApiInfo
API - #2196 via @fredrikhr
requested_action
field on check_run
events - #2197 via @mitchdenny
WatchersCount
to Repository
response model - #2182 via @KarolGrzesiak, @shiftkey
Housekeeping
Microsoft.NET.Test.Sdk
to latest version - #2183, #2178 via @dependabot-preview[bot]
xunit.runner.visualstudio
to latest version - #2198 via @dependabot-preview[bot]
ChecksClient
constructor should take interface arguments - #2194 via @fredrikhr