« Changelog History


Octokit.NET v0.30.0 Release Notes

Release Date: 2018-06-17 // almost 6 years ago

  • 📦 Packages

    📦 Octokit 0.30.0 on NuGet
    📦 Octokit.Reactive 0.30.0 on NuGet

    Advisories and Breaking Changes

    • 🚚 Note that the IssuesLabelsClient.RemoveFromIssue() methods which previously had no return value, will now return an IReadonlyList<Label>. This change is source compatible but not binary compatible.
    • 🚚 The following [Obsolete] items have been removed from octokit, please use the indicated replacements:

    Client Methods

    • OranizationsClient.GetAll() => GetAllForUser()
    • PullRequestsClient.Comment => ReviewComment
    • RepositoryBranchesClient.GetRequiredStatusChecksContexts() => GetAllRequiredStatusChecksContexts()
    • RepositoryBranchesClient.GetProtectedBranchTeamRestrictions() => GetAllProtectedBranchTeamRestrictions()
    • RepositoryBranchesClient.GetProtectedBranchUserRestrictions() => GetAllProtectedBranchUserRestrictions()
    • RepositoryTrafficClient.GetReferrers() => GetAllReferrers()
    • RepositoryTrafficClient.GetPaths() => GetAllPaths()
    • TeamsClient.GetMembership() => GetMembershipDetails()
    • TeamsClient.AddMembership() => AddOrEditMembership()
    • TeamsClient.AddMembership() => AddOrEditMembership()

    Request Models

    • ✂ Remove unwanted ctor's from BranchProtectionUpdateSettings and UpdateTeam
    • NewIssue Assignee => Assignees
    • ⚡️ IssueUpdate Assignee => Assignees

    Response Models

    • TeamMembership => TeamMembershipDetails

    🚀 Release Notes

    Milestone: GitHub Apps

    🔋 Features/Enhancements

    Milestone: None

    🔋 Features/Enhancements

    • ➕ Added PreviousFileName field to PullRequestFile response - #1770 via @Kaneraz
    • 👌 Support PullRequestReviewEvent payloads using new response model PullRequestReviewEventPayload - #1767 via @Cyberboss
    • ➕ Add the ability to search issues by milestones, using SearchIssuesRequest.Milestone - #1788 via @mkArtak
    • ➕ Add an overload to IReleasesClient.Get() that allows retrieving a Release by the associated tag - #1793 via @tasadar2, @ryangribble
    • ➕ Add MaintainerCanModify field to PullRequest response and NewPullRequest and UpdatePullRequest requests - #1771 via @Cyberboss, @ryangribble
    • 👍 Enabled additional methods for preview "Nested Teams" support:
      • IRepositoriesClient.GetAllTeams()
      • IRepositoryBranchesClient.GetAllProtectedBranchTeamRestrictions()
      • IRepositoryBranchesClient.UpdateProtectedBranchTeamRestrictions()
      • IRepositoryBranchesClient.AddProtectedBranchTeamRestrictions()
      • IRepositoryBranchesClient.DeleteProtectedBranchTeamRestrictions() - #1795 via @MikhailTymchukDX, @ryangribble
    • Implement Pre Receive Environments API (Preview) for GitHub Enterprise - #1796 via @tasadar2, @ryangribble
    • 0️⃣ Implement support for Label API Improvements, including additional fields (Description and Default), emoji support and searching for labels (SearchClient.SearchLabels()) - #1802 via @jozefizso, @ryangribble

    Housekeeping

    • Correct missing/incorrect XmlDoc entries for parameters on some methods - #1779 via @ryangribble
    • 👻 Parameter names in validation exception messages are now derived from the parameters themselves, rather than a literal string that was hopefully kept up to date - #1781 via @itaibh
    • ⚡️ Update Octokit build tooling to use .NET SDK 2.x (note that this is only an SDK tooling update - Octokit and Octokit.Reactive libraries are still targeting netstandard1.1) - #1784 via @ryangribble
    • ✂ Removed a number of [Obsolete] methods, members and constructors inline with our standard deprecation schedule - #1780 via @ryangribble
    • ✅ Ensure all response models have appropriate ctor's to allow mocking, and enforce with a convention test - #1798 via @tasadar2, @ryangribble

    📚 Documentation Updates