Releases: octokit/octokit.rb
Releases · octokit/octokit.rb
v4.23.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 (#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: #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: v4.22.0...v4.23.0
Contributors
etiennebarrie, Fryguy, and 15 other contributors
Assets 2
v4.22.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:
❗
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
Contributors
olleolleolle, bencolon, and 5 other contributors
Assets 2
v4.21.0
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
Code clean up
Documentation
v4.20.0
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
v4.19.0
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
v4.18.0
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
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
Documentation
- #1137 Clarify force parameter documentation @rmacklin
- #1186 Fix
team_by_nameexample @steinbrueckri - #1190 Fix API links in the Apps client @ybiquitous
Tooling updates
v4.15.0
Preview header support
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
versiondeprecation 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
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 fromrepo/usertouser/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#collaboratorsmethod #1105 (@ybiquitous)
New features
- Add client methods for the Checks API #1101 (@laserlemon)