Skip to content

Upgrading octokit 5 to 6

Breaking5.6.1 → 6.1.1Breaking3Security1New4Changed3Fixed3Other26

Full comparisonBack to octokit
BreakingUpgrade verdict

3 breaking changes and a security fix.

In plain terms
  • The method for listing available webhook hooks has been removed.
  • Updating a git reference no longer forces the update unless you ask for it.
  • The client module for managing OAuth authorizations has been removed.
  • Error messages no longer leak your API token when it was passed in the URL.
Must act 4 items need code or config changes

What you must change

Breaking3
Removes Octokit::Client::Hooks#available_hooks.
Octokit::Client::Hooks#available_hooks
6.0.0GitHub ReleaseSummarizedView source
Changes the default value of update_ref force to false.
update_refforce
6.0.0GitHub ReleaseSummarizedView source
Removes Octokit::Client::Authorizations.
Octokit::Client::Authorizations
6.0.0GitHub ReleaseSummarizedView source
Security1
Ensures an API token set in the URL is never present in clear text in the error stack trace.
6.1.1GitHub ReleaseSummarizedView source

API changes

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

  • removed: method Authorizations.authorization(_, _ = …)
  • removed: method Authorizations.authorizations(_ = …)
  • removed: method Authorizations.authorize_url(_ = …, _ = …)
  • removed: method Authorizations.create_authorization(_ = …)
  • removed: method Authorizations.delete_authorization(_, _ = …)
  • removed: method Authorizations.revoke_all_application_authorizations(_ = …)
  • removed: method Authorizations.scopes(_ = …, _ = …)
  • removed: method Authorizations.update_authorization(_, _ = …)
  • removed: method Hooks.available_hooks(_ = …)
  • removed: module Authorizations
  • added: method Environments.create_or_update_environment(_, _, _ = …)
  • added: method Environments.delete_environment(_, _, _ = …)
  • added: method Environments.environment(_, _, _ = …)
  • added: method Environments.environments(_, _ = …)
  • added: method Environments.list_environments(_, _ = …)
  • added: method Organizations.delete_org(_)
  • added: method Organizations.delete_organization(_)
  • added: method Tokens.scopes(_ = …, _ = …)
  • added: module Environments
  • added: module Tokens