Changelog History
Page 3
-
v0.28.0 Changes
November 06, 2017๐ฆ Packages
๐ฆ
Octokit 0.28.0
on NuGet
๐ฆOctokit.Reactive 0.28.0
on NuGetAdvisories and Breaking Changes
- ๐ This release has been pushed out in response to
CommitStatus.Id
on GitHub exceedingInt32.MaxValue
. We've made this field along
now... sorry about that!
๐ Release Notes
๐ Features/Enhancements
- ๐ You can now use
IGitHubClient.SetRequestTimeout(TimeSpan timeout)
to set a custom timeout, particularly useful for lengthy operations such as uploading release assets. - #1693 via @pmiossec, @ryangribble
๐ Fixes
- โก๏ธ Update
CommitStatus.Id
field fromint
tolong
to prevent overflow exceptions - #1703 via @kzu
Housekeeping
- ๐ This release has been pushed out in response to
-
v0.27.0 Changes
October 07, 2017๐ฆ Packages
๐ฆ
Octokit 0.27.0
on NuGet
๐ฆOctokit.Reactive 0.27.0
on NuGetAdvisories and Breaking Changes
NewTeam.Permission
has been changed to a nullable typePermission?
and will no longer be sent unless explicitly set
๐ Release Notes
๐ Features/Enhancements
- โก๏ธ Implement additional fields in
Team
response andNewTeam
andUpdateTeam
requests, forPrivacy
,Maintainers
andDescription
where they were missing - #1669 via @ryangribble - Implement
Organization
filter inISearchClient.SearchCode()
- #1672 via @sepharg, @ryangribble - โก๏ธ Implement team membership enhancements for role (Maintainer or Member) and state (Active or Pending) including new methods
TeamsClient.AddOrEditMembership()
andTeamsClient.GetMembershipDetails()
and updatingTeamsClient.GetAllMembers()
to allow filtering by role. - #1670 via @ryangribble - Implement Nested Teams API (Preview) - #1682 via @ryangribble
๐ Fixes
- ๐ Assembly versioning, NuGet package metadata and inter-package version dependencies should now be correct, after automating them via the build process - #1660 via @ryangribble, @mderriey
- ๐ป Octokit can now run in environments where
PlatformNotSupported
exception was encountered when initializing the API connection (eg AWS Lambda) - #1660 via @ryangribble, @mderriey - Intellisense should once again be available for Octokit libraries - sorry about that! - #1674 via @mderriey
ISearchClient.SearchRepo()
now uses the correct values for theForks
search qualifiers (Include
orOnly
) - #1680 via @ryangribble
Housekeeping
- โ Add convention tests to enforce API Pagination support and naming conventions - #1659 via @ryangribble
- ๐คก BranchProtection response class
EnforceAdmins
now provides a standardctor
allowing it to be mocked if required - #1679 via @ryangribble
-
v0.26.0 Changes
August 31, 2017๐ฆ Packages
๐ฆ
Octokit 0.26.0
on nuget
๐ฆOctokit.Reactive 0.26.0
on nugetAdvisories and Breaking Changes
- This release contains the necessary Octokit changes to specify the
required_pull_request_reviews
field on Branch Protection updates, which becomes mandatory when the Protected Branches API graduates from preview mode on the 1st September
๐ Release Notes
๐ Features/Enhancements
- โก๏ธ Implement
RequiredPullRequestReviews
support inIRepositoryBranchesClient.UpdateBranchProtection
and additional granular methods toGetReviewEnforcement
,UpdateReviewEnforcement
andRemoveReviewEnforcement
via @M-Zuber, @ryangribble
- This release contains the necessary Octokit changes to specify the
-
v0.25.0 Changes
August 23, 2017๐ฆ 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
-
v0.24.0 Changes
January 17, 2017Features/Enhancements
- โ Add
GetAll
method toOrganizationsClient
- #1469 via malamour-work - โ Add missing fields to
Repository
class -HasPages
,SubscribersCount
,Size
- #1473 via ryangribble - ๐ Allow base64 content for create/update file - #1488 via laedit
- โ Add
HtmlUrl
field toMilestone
class - #1489 via StanleyGoldman - โ Add support for passing sort options to
IssueCommentsClient.GetAllForRepository()
- #1501 via pjc0247 - ๐ Rename
PullRequest.Comment
toPullRequest.ReviewComment
for better accuracy - #1520 via bmeverett - ๐ Introduce
AbuseException
- #1528 via SeanKilleen - โ Add
Id
field toPullRequest
class - #1537 via YunLi1988 - 0๏ธโฃ Unparseable
ApiErrors
should now fall back to better default error messages - #1540 via SeanKilleen
๐ Fixes
- ๐ Fix errors in
ObservableEventsClient
caused by incorrect return types - #1490 via StanleyGoldman - โ Add missing
SecurityCritical
attribute onGetObjectData()
overrides - #1493 via M-Zuber - ๐ Fix exceptions in Events API by adding missing event types to
EventInfo
enumeration - #1536 via lynnfaraday - โ Add new AccountType "Bot" to prevent deserialization errors - #1541 via ryangribble
๐ Documentation Updates
- ๐ Clarify
ApiInfo
rate limiting usage in docs - #1524 via SeanKilleen - ๐ Clarify label coloring usage in docs - #1530 via SeanKilleen
๐ฅ Breaking Changes
- โก๏ธ Creating and Editing Issues (and PullRequests) using
NewIssue
andIssueUpdate
requests
๐ should now use theAssignees
collection rather than the now deprecatedAssignee
field.
Both fields can't be specified on the same request, so any code still usingAssignee
will
need to explicitly setAssignees
tonull
to avoid Api validation errors. OrganizationsClient.GetAll(string user)
has been marked obsolete in favour of
OrganizationsClient.GetAllForUser(string user)
PullRequest.Comment
has been marked obsolete in favour ofPullRequest.ReviewComment
- Several
EventsClient
methods previously returned the incorrectActivity
response class.
This has been corrected toIssueEvent
which although is now correct could break calling
code that was written assuming this previous incorrect return type.
- โ Add
-
v0.23.0 Changes
October 07, 2016Features
- โ Added support to test whether a URL points to a GitHub Enterprise instance - #1404 via @haacked
- โ Added granular methods for Protected Branches preview API - #1443 via @maddin2016
- ๐ Repository Traffic preview API support - #1457 via @maddin2016
- ๐ Preview API for merge/squash/rebase in repository settings - #1477 via @ryangribble
- โ Added support for performing a rebase and merge through the API- #1479 via @ryangribble
๐ Fixes
- Repository identifiers now use
long
instead ofint
- #1445 via @shana, #1485 via @ryangribble - Searching for C# through the GitHub API now uses the correct alias - #1463 via @dampir
- Resolved deadlocking scenario in async/await usage - #1486 via @zzzprojects
Other
- ๐ LINQPad samples are now verified at build time - #1456 via @mderriey
- ๐ More obsolete APIs removed - #1458 via @ryangribble
- ๐ .NET Core support has been started - #1462 via @mderriey
๐ฅ Breaking Changes
โก๏ธ Repository identifiers returned from the GitHub API will exceed
Int32.MaxValue
in around 12 months, based on current growth. We've decided to update everywhere we require (or return) a repository identifier fromint
tolong
so that these will continue to work in the future, and the implicit conversion fromint
tolong
means the impact should be manageable now.๐
MergePullRequest.Squash
has been marked as obsolete in favour of theMergeMethod
property - usePullRequestMergeMethod.Squash
orPullRequestMergeMethod.Rebase
if you want to change the merge behaviour when merging a pull request.