Exception: GitHub::API::AuthenticationFailedError Private

Inherits:

Object
RuntimeError
Error
GitHub::API::AuthenticationFailedError

Defined in:: utils/github/api.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Error when authentication fails.

Instance Method Summary collapse

#initialize(credentials_type, github_message) ⇒ void constructor private

Methods included from Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_upgradable, #pretty_warning

Constructor Details

#initialize(credentials_type, github_message) ⇒ `void`

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

credentials_type (Symbol)
github_message (String)

# File 'utils/github/api.rb', line 113

def initialize(credentials_type, github_message)
  message = "GitHub API Error: #{github_message}\n"
  message << case credentials_type
  when :github_cli_token
    <<~EOS
      Your GitHub CLI login session may be invalid.
      Refresh it with:
        gh auth login --hostname github.com
    EOS
  when :keychain_username_password
    <<~EOS
      The GitHub credentials in the macOS keychain may be invalid.
      Clear them with:
        printf "protocol=https\\nhost=github.com\\n" | git credential-osxkeychain erase
    EOS
  when :env_token
    require "utils/formatter"
    <<~EOS
      `$HOMEBREW_GITHUB_API_TOKEN` may be invalid or expired; check:
#{Formatter.url("https://github.com/settings/tokens")}    EOS
  when :none
    NO_CREDENTIALS_MESSAGE
  end
  super message.freeze, github_message
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/GitHub/API/AuthenticationFailedError.html