Octokit.NET v0.25.0 Release Notes
Release Date: 2017-08-23 // over 6 years ago-
๐ฆ Packages
๐ฆ
Octokit 0.25.0
on nuget
๐ฆOctokit.Reactive 0.25.0
on nugetAdvisories and Breaking Changes
๐ฑ Octokit.net has been ported to dotnetcore ๐ providing libraries targetting
netstandard1.1
andnet45
frameworks๐
Enum
fields in Octokit response classes are now wrapped in anStringEnum<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 inBranchProtectionRequiredStatusChecks
andBranchProtectionRequiredStatusChecksUpdate
classes, instead use the newEnforceAdmins
field onBranchProtectionSettingsUpdate
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
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 forOrganizationMembersClient
(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 forOrganizationMembersClient
andTeamsClient
(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 newEventInfoState
values - #1563 via @ryangribble - ๐ Fix
NotificationsClient.MarkAsRead()
exception by specifying a payload body in thePUT
request - #1579 via @shiftkey, @ryangribble - ๐ Fix
connection.GetLastApiInfo()
was returningnull
in some situations - #1580 via @ryangribble - ๐ Fix even more
IssueTimelineClient
deserialization exceptions by adding even more newEventInfoState
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
tostring
- #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