Skip to content

Upgrading octokit 8 to 9

Breaking8.1.0 → 9.2.0Breaking1Platform1New5Changed2Fixed4Other9

Full comparisonBack to octokit
BreakingUpgrade verdict

1 breaking change and a platform requirement change.

In plain terms
  • The library no longer supports GitHub's webhook subscription (PubSubHubbub) feature.
  • The library now officially supports Ruby 3.3.
Must act 2 items need code or config changes

What you must change

Breaking1
Removes the PubSubHubbub module and the /hub API endpoint implementation.
PubSubHubbub
9.0.0GitHub ReleaseSummarizedView source
Platform1
Adds Ruby 3.3 as a supported Ruby version.
9.0.0GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published Ruby source. Not mixed with prose notes.

  • added: static method Octokit.manage_ghes_client()
  • added: class Deprecated < ClientError
  • added: class ManageGHESClient
  • added: const Repository.ABS_URI_REGEXP
  • added: constructor ManageGHESClient(_ = …)
  • added: method Configurable.manage_ghes_endpoint()
  • added: method ManageGHESClient.add_authorized_key(_)
  • added: method ManageGHESClient.authorized_keys()
  • added: method ManageGHESClient.config_check()
  • added: method ManageGHESClient.config_status()
  • added: method ManageGHESClient.delete_authorized_key(_)
  • added: method ManageGHESClient.edit_settings(_)
  • added: method ManageGHESClient.get_authorized_keys()
  • added: method ManageGHESClient.get_settings()
  • added: method ManageGHESClient.remove_authorized_key(_)
  • added: method ManageGHESClient.settings()
  • added: method ManageGHESClient.start_configuration()
  • added: method ManageGHESClient.upload_license(_)
  • added: property Configurable.manage_ghes_endpoint: writer
  • added: property Configurable.manage_ghes_password: writer
  • added: property Configurable.manage_ghes_username: writer
  • added: protected method ManageGHESClient.endpoint()
  • added: protected set ManageGHESClient.manage_ghes_endpoint(_)
  • added: protected set ManageGHESClient.manage_ghes_password(_)
  • added: protected set ManageGHESClient.manage_ghes_username(_)
  • added: static method Default.manage_ghes_endpoint()
  • added: static method Default.manage_ghes_password()
  • added: static method Default.manage_ghes_username()
  • removed: method PubSubHubbub.subscribe(_, _, _ = …)
  • removed: method PubSubHubbub.subscribe_service_hook(_, _, _ = …, _ = …)
  • removed: method PubSubHubbub.unsubscribe(_, _)
  • removed: method PubSubHubbub.unsubscribe_service_hook(_, _)
  • removed: module PubSubHubbub
  • changed: method PullRequests.create_pull_comment(_, _, _, _, _, _, _ = …) → method PullRequests.create_pull_comment(_, _, _, _, _, _ = …, _ = …)
  • changed: method PullRequests.create_pull_request_comment(_, _, _, _, _, _, _ = …) → method PullRequests.create_pull_request_comment(_, _, _, _, _, _ = …, _ = …)
  • changed: method PullRequests.create_view_comment(_, _, _, _, _, _, _ = …) → method PullRequests.create_view_comment(_, _, _, _, _, _ = …, _ = …)
  • added: method Apps.app_hook_delivery(_, _ = …)
  • added: method CodeScanning.delete_code_scanning_analysis(_, _, _ = …)
  • added: method CodeScanning.get_code_scanning_alert(_, _, _ = …)
  • added: method CodeScanning.get_code_scanning_analysis(_, _, _ = …)
  • added: method CodeScanning.get_code_scanning_default_config(_, _ = …)
  • added: method CodeScanning.get_codeql_database_for_repo(_, _, _ = …)
  • added: method CodeScanning.list_code_scanning_alerts_for_org(_, _ = …)
  • added: method CodeScanning.list_code_scanning_alerts_for_repo(_, _ = …)
  • added: method CodeScanning.list_code_scanning_analysis(_, _ = …)
  • added: method CodeScanning.list_codeql_database_for_repo(_, _ = …)
  • added: method CodeScanning.list_instances_of_code_scanning_alert(_, _, _ = …)
  • added: method CodeScanning.update_code_scanning_alert(_, _, _, _, _ = …, _ = …)
  • added: method CodeScanning.update_code_scanning_default_config(_, _, _ = …, _ = …, _ = …)
  • added: method Repositories.automated_security_fixes_enabled?(_, _ = …)
  • added: method Repositories.disable_automated_security_fixes(_, _ = …)
  • added: method Repositories.enable_automated_security_fixes(_, _ = …)
  • added: method ManageAPI.configure_maintenance_mode(_, _ = …)
  • added: method ManageAPI.maintenance_mode()
  • added: method ManageAPI.set_maintenance_mode(_, _ = …)
  • added: module ManageAPI