v4.17.0

ATTENTION: This has release has known errors

In an effort to help users migrate to the new OAuth Applications API, a pull request was opened to update the existing endpoints: #1203.

Unfortunately the URLs for these endpoint changes were incorrect and were not caught as part of the test suite. In order to keep continuity we are keeping the release, but we have pulled this version from Rubygems.org.

Please update to v4.18.0 or above.

We apologize for the inconvenience this may have caused.

v4.16.0

New features

• #1187 Support for Commit Branches @tgmachina

Resolve deprecation warnings

• #1192 Fix deprecation notice for authentication via query parameters @tarebyte

Documentation

• #1137 Clarify force parameter documentation @rmacklin
• #1186 Fix team_by_name example @steinbrueckri
• #1190 Fix API links in the Apps client @ybiquitous

Tooling updates

• #1185 Fix action builds against 4-stable @tarebyte

v4.15.0

Preview header support

• #1114 Adds drafts preview header @andrew
• #1132 Update branch protection preview @spikex

New features

• #1133 Support for template repositories @EricPickup
• #1136 Add method to find team by name @gallexi
• #1153 Add method to delete installation @yykamei
• #1151 Add method to update pull request review @eric-silverman
• #1162 Support for Commit pulls @tgmachina

Improved error handling

• #1115 Add BillingIssue error @stmllr
• #1106 Add TooLargeContent error @ybiquitous
• #1164 Add SAMLProtected error @tarebyte

Resolve deprecation warnings

• #1152 Fix version deprecation warning in ci builds @hmharvey
• #1154 Fix faraday error subclass @Gasparila

Documentation

• #1123 Add option in the pull request state parameter @4geru
• #1135 Fix the contributing doc steps @gallexi
• #1134 Fix the code example for update branch @rmacklin
• #1139 Add assignee params @4geru
• #1138 Update link to new collaborators api @shaunakpp
• #1129 Add code of conduct @spikex
• #1102 Update readme to point directly to v3 api @binhums

Tooling updates

• #1142 Migrated to actions @tarebyte

v4.14.0

Bug fixes

• Support auto pagination in org_projects #1090 (@mattr-)
• Support falsy values in configuration #1091 (@nickstanish)
• fixup ssl verify mode #1098 (@tnaoto)

Code cleanup

• Change the raise_invalid_repository! msg from repo/user to user/repo #1094 (@DaiAoki)
• Fix redundant code in Octkit::Client #1100 (@rnitta)

Documentation

• Adds timeout instructions to readme #1089 (@abinoda)
• Fix docs of #repository? return value type #1092 (@vecerek)
• Update doc of Repositories#collaborators method #1105 (@ybiquitous)

New features

• Add client methods for the Checks API #1101 (@laserlemon)

v4.13.0

Bug fixes

• Fixes 422 error for passing client_id when making a new OAuth Authorization #1077 (@tarebyte)

Documentation

• Add Octopoller section to readme #1073 (@BenEmdon)

Support for new preview headers

• Add new strict validation preview header #1078 (@tarebyte)

Testing fixes

• Update WebMock and VCR / update Octokit::Client::Authorizations spec #1077 (@tarebyte)

v4.12.0

Support for additional APIs

#1060 Add support for Transfer repository API
#1070 Add support for List Assignees API
#975 Add support for Community Profile API

Bugfixes

#1069 Do not pass wrong params in org membership method

v4.11.0

Code clean up

• #1054 Remove the :name key from #add_team_repository request

Documentation fixes

• #1050 Add in note about require
• #1056 Fixes documentation url for outside_collaborators

Existing endpoint changes

• #1055 Use new app installation token endpoint

Support new endpoints

• #1052 App installation finders

v4.10.0

Graduated preview periods

• #1020 Remove preview warning for marketplace API
• #1041 Remove marketplace preview warnings (we mean it, this time)
• #1042 Remove preview warning for Repository Invitations API
• #1047 Rework request review API to support team reviewers

Support for new endpoints

• #1044 Implement Topics API
• #990 Implement delete a pull request review request

Bugfixes

• #1025 Fix contributors endpoint for empty repos
• #1034 Duplicate option to prevent mutating original
• #1018 Convert OCTOKIT_SSL_VERIFY_MODE environment variable to integer

Enhancements

• #1021 Add Faraday retry middleware
• #1032 Use auto pagination when retrieving statuses

v4.9.0

Bugfixes

• #1006 Use Addressable::URI instead of stdlib URI for normalization
• #1003 Fix pagination of GitHub App endpoints
• #1000 Call dup on arguments before mutating

Documentation changes

• #969 Document the steps necessary to cut a release
• #972 Url to the review API was wrong
• #973 Fix pull_requests_comments example documentation
• #985 Add tag_name to update_release documentation
• #989 Command example fix in documentation.
• #1008 Fixes documentation for getting single issue comment
• #1011 Fix example call to Octokit.label

Enhancements

• #982 Be able to set an SSL verify mode on faraday
• #1009 Add missing remove_org_membership alias

Maintenance

• #970 Update Ruby versions for CI
• #961 Update VCR gem

Support for additional API endpoints

• #984 Add remove_assignees method to the client
• #959 Commit Search API preview
• #996 Add ability to list a single deployment, by id

v4.8.0

Support for additional API endpoints

• #885 Topics API
• #884 Get a single Installation
• #894 Add assignees
• #895 Find user installations
• #929 Marketplace listings API
• #928 Nested Teams API
• #938 Get user's marketplace purchases
• #932 GitHub Apps API

APIs taken out of preview

• #913 Organization Memberships API
• #923 Pull Request Review API

Enhancements

• #886 Allow reviews and review comments to be paginated
• #899 Expose response_headers and response_body on error objects
• #877 Improve error message when Octokit::Repository.new fails
• #958 Update add/remove installations methods to use non-deprecated endpoints
• #892 Move integrations endpoints across to apps

Bugfixes

• #876 Remove destructive assignment for repository
• #966 Fix apps client for GitHub Enterprise installs (new endpoints in this release, but still)

Note about Rubinius support

We have been unable to get a Rubinius build working for CI for quite some time, meaning that Rubinius support has been spotty or non-existent. In this release we finally stopped trying. This isn't directly backwards-incompatible since it already wasn't working, but it does feel a bit iffy.

If you happen to use Rubinius and know how to get this working on Travis, we'd be delighted to review a pull request that adds it back in.