octokit.rb

✅ NOTE: This remediates A security advisory was published on versions 4.23.0 and 4.24.0 of this gem. You can read more about this in the published security advisory. ✅

DX Improvements

• Rubocop improvements by @timrogers in https://github.com/octokit/octokit.rb/pull/1441
• Require multi-factor authentication to push new releases to RubyGems by @timrogers in https://github.com/octokit/octokit.rb/pull/1443

CI Improvements

Updates all build scripts to be more durable and adds details on how to run a manual file integrity check by @nickfloyd in https://github.com/octokit/octokit.rb/pull/1446

Housekeeping

• Drop support for Ruby 1.9.2 in Octokit::Client::Contents#create_contents by @timrogers in https://github.com/octokit/octokit.rb/pull/1442

Full Changelog: https://github.com/octokit/octokit.rb/compare/v4.24.0...v4.25.0

❗ NOTE: A security advisory has been published on version 4.24.0 of this gem. This gem was published with world-writeable files. You can read more about this in the published security advisory. ❗

Known issues

Note: This release fixes the issue around autoloading modules causing some modules to not load before use #1428

Code improvements

• #1354, #1426 Enabling Ruby's immutable ("frozen") string literals i.e. --enable-frozen-string-literal via @timrogers and @olleolleolle

CI Improvements

• Adds Code QL analysis to octokit.rb via @nickfloyd

Bug fixes

• #1428 Fixes module loading issue with autoloading (this reverts #1351 ) - more information here via @collinsauve. @waiting-for-dev, @etiennebarrie, @timrogers, and @nickfloyd

Full Changelog: https://github.com/octokit/octokit.rb/compare/v4.23.0...v4.24.0

❗ NOTE: A security advisory has been published on version 4.23.0 of this gem. This gem was published with world-writeable files. You can read more about this in the published security advisory. ❗

Known issues

Autoloading modules cause some modules to not load before use

• What: This version implements autoloading for some modules. The initial change was deemed good but our community has since come across issues where autoloading could cause issues due to modules not being loaded or load order even.
• Action: We will be rolling back this change in the next release (https://github.com/octokit/octokit.rb/pull/1428)
• Next steps: This change provides value in the cases where this is not an issue so we are going to work to come up with an opt-in approach. More details here.
• Work around: https://github.com/octokit/octokit.rb/pull/1420

Hat tip to: @collinsauve. @waiting-for-dev, @etiennebarrie, and @timrogers for the discovery around this.

Code improvements

• #1382 Correctly raise Octokit::TooManyRequests when hitting secondary rate limit via @jasonopslevel
• #1411 Adds support for Faraday v2 usage via @skryukov

CI Improvements

• #1395 Adds Ruby 3.1 to CI via @petergoldstein

Performance improvements

• #1351 Make clients autoload via @gmcgibbon

Bug fixes

• #1297 Escape label names with URL characters via @Fryguy
• #1375 Escape ref in archive_link via @max611
• #1117 & #1419 Ensures that any nil parameters being passed in will initialize with Octokit's defaults instead of nil via @akerl, @nickfloyd
• #1321 & #1415 Fixed total_count calculation when paginating results for check runs and check suites via @a2ikm, @matiasalbarello
• #1121 Fixes service status methods via @vierarb

Documentation

• #1414 replace git.io link in source docs via @wonda-tea-coffee
• #1412 Document how and when the SDK raises exceptions via @timrogers
• #1356 Fixes grammar and style via @nikoandpiko

Full Changelog: https://github.com/octokit/octokit.rb/compare/v4.22.0...v4.23.0

This version should be considered deprecated, and users should use or update to >= v4.23.0

Known issues

❗

Issue
Faraday gemspec version is mismatched with implemented APIs and middleware.

Back in January 2022, with the v4.22.0 release Faraday 1.x features were added but we never updated the gemspec from '>= 0.9' to >=1 but we later released v4.23.0 with the correct version specified.

This is causing an issue because in the 4.22.0 changeset, we introduced middleware that uses 1.x faraday features but dependency resolution some cases still tries to use 0.9 and not 1.x

Resolution
This version is being marked as deprecated. Please update to update to >= v4.23.0 of the octokit.rb gem.

References:

https://github.com/octokit/octokit.rb/issues/1392 | https://github.com/octokit/octokit.rb/issues/1389

❗

Deprecation Fix

• #1359 Fix Faraday deprecation warning @ybiquitous

Code Improvements

• #1336 Update regex for create ref @thepwagner
• #1350 Support pagination in compare api @mrpinsky

CI and dependency updates

• #1353 Add Ruby 3.0 support for CI builds @olleolleolle
• #1387 Update pry-byebug requirement @ashishkeshan

Documentation

• #1376 Update example README code with token filtering @bencolon
• #1381 Update organization migration documentation links @rzhade3

API Support

• #1319 Add delete workflow run support @szemek
• #1322 Add match refs support @AHaymond
• #1329 Add rename branch support @gmcgibbon
• #1332 Add billing actions support @M-Yamashita01

Error handling

• #1324 Handle path diff too large errors @yykamei

Code clean up

• #1326 Remove graduated preview headers @ivailop

Documentation

• #1314 Update authentication usage @curquiza
• #1317 Fix logo link @gjtorikian
• #1318 Fix GitHub typo @bl-ue

API Support

• #1304 Added the ability to delete a deployment @jer-k
• #1308 Add repo vulnerability alerts related functionality for repositories @calvinhughes

Bug fixes

• #1309 Paginate outside_collaborators calls @sds
• #1316 Uses of FaradayMiddleware#on_complete should not be private @tarebyte

Code improvements

• #1131 Add CommitIsNotPartOfPullRequest error @wata727
• #1303 Remove integrations preview header @MichaelViveros
• #1307 Raise Octokit::InstallationSuspended when another error is received @yykamei

Documentation

• #1302 Add documentation on how to specify the ref option for RubyDoc @aomathwift
• #1311 Fix Code of Conduct link in Table of Contents @eduardoj

Code Improvements

• #1223 Ensure a boolean is returned for application_authenticated @zakallen
• #1255 Update api paths in the organization api to take ids @hmharvey
• #1260 Fix last_response behavior after failures @JackTLi
• #1253 Ensure adapters set SSL options properly @tjwallace
• #1270 Add context around rate limit errors @jatindhankhar

API Support

• #1252 Introduces support for the ActionWorkflow and ActionWorkflowRun APIs @petar-lazarov
• #1236 Support for ActionsSecrets API @jylitalo
• #1266 Support for get the authenticated app @kitop
• #1281 Support for create a workflow dispatch event @igfoo
• #1286 Support installation suspended failures @stmllr
• #1288 Support for user migration endpoints @stmllr

Documentation

• #1248 Fix documentation link for update a repository @spier
• #1269 Update some documentation param names @tarebyte
• #1276 Remove dangling phrase in CONTRIBUTING.md @igfoo
• #1278 Link related doc in CONTRIBUTING.md @igfoo
• #1279 Fix script typo in README.md @igfoo
• #1291 Fix typo in authorizations comments @ohbarye

CI and dependency updates

• #1206 Increased CI coverage @MSP-Greg
• #1243 Add Ruby 2.7 CI support @ybiquitous
• #1244 Removed coveralls dependency @hmharvey
• #1263 Remove duplicated CI coverage @hmharvey
• #1264 Keep running CI on PRs @hmharvey

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: https://github.com/octokit/octokit.rb/pull/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.

Documentation

• #1200 Fix an API link in the Search client @NickLaMuro

Preview Header Support

• #1183 Enable issue events API to return project events @gammons
• #1203 Update deprecated application API to new preview @oreoshake

Bug Fixes

• #1201 Fix random test failures @MSP-Greg
• #1218 Fix incorrect URLs for the Authorizations client @tarebyte

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

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

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)

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)

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

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

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

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

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.

• #837 Fix passing options to all_organizations
• #841 Add new methods from the most recent org memberships API enhancements
• #851 Fix application requests for non dotcom hosts
• #858 Don't mutate the options variable passed to API calls
• #871 Add support to prerelease Integrations API
• #874 Handle PR Review errors
• #860 Implement Review Preview API
• #869 Use Organization.path for organization membership method
• #880 Fix incorrect mimetype for integrations in PREVIEW_TYPES
• #881 Change several occurrences of Hash#merge!

Library Changes

#829 Sawyer dependency loosened to support new release 'sawyer', '>= 0.5.3', '~> 0.8.0' Thank you @andrew

Updated Methods

#821

• #protect_branch required_status_check parameter is no longer required, which makes the method call signature changed. required_status_check can be passed in the options hash.
• #unprotect_branch returns a boolean value now

New Methods

#820 Projects APIs https://developer.github.com/v3/projects/

• #projects List projects for a repository
• #create_project Create a Project
• #org_projects List Organization Projects
• #create_org_project Create Organization Project
• #project Get a Repository Project
• #update_project Update a Project
• #delete_project Delete a Project
• #project_columns List a Project's Columns
• #create_project_column Create a Project Column
• #project_column Get a Project Column
• #update_project_column Update a Project Column
• #delete_project_column Delete a Project Column
• #move_project_column Move a Project Column
• #column_cards List Column Cards
• #create_project_card Create a Project Card
• #project_card Get a Project Card
• #update_project_card Update a Project Card
• #move_project_card Move a Project Card
• #delete_project_card Delete a Project Card

#824 Traffic APIs https://developer.github.com/v3/repos/traffic/

• #top_referrers Get the top 10 referrers over the last 14 days.
• #top_paths Get the top 10 popular contents over the last 14 days.
• #views Get the total number of views and breakdown per day or week for the last 14 days.
• #clones Get the total number of clones and breakdown per day or week for the last 14 days.