Exception: BuildError Private
- Includes:
- Utils::Output::Mixin
- Defined in:
- exceptions.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.
Raised when an error occurs during a formula build.
Instance Attribute Summary collapse
- #args ⇒ Object readonly private
- #cmd ⇒ Object readonly private
- #env ⇒ Object readonly private
- #formula ⇒ Object private
- #options ⇒ Object private
Instance Method Summary collapse
- #dump(verbose: false) ⇒ void private
- #fetch_issues ⇒ Array<T.untyped> private
- #initialize(formula, cmd, args, env) ⇒ void constructor private
- #issues ⇒ Array<T.untyped> private
Methods included from Utils::Output::Mixin
#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled
Constructor Details
#initialize(formula, cmd, args, env) ⇒ 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.
481 482 483 484 485 486 487 488 |
# File 'exceptions.rb', line 481 def initialize(formula, cmd, args, env) @formula = formula @cmd = cmd @args = args @env = env pretty_args = Array(args).map { |arg| arg.to_s.gsub(/[\\ ]/, "\\\\\\0") }.join(" ") super "Failed executing: #{cmd} #{pretty_args}".strip end |
Instance Attribute Details
#args ⇒ Object (readonly)
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.
470 471 472 |
# File 'exceptions.rb', line 470 def args @args end |
#cmd ⇒ Object (readonly)
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.
470 471 472 |
# File 'exceptions.rb', line 470 def cmd @cmd end |
#env ⇒ Object (readonly)
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.
470 471 472 |
# File 'exceptions.rb', line 470 def env @env end |
#formula ⇒ Object
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.
471 472 473 |
# File 'exceptions.rb', line 471 def formula @formula end |
#options ⇒ Object
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.
471 472 473 |
# File 'exceptions.rb', line 471 def @options end |
Instance Method Details
#dump(verbose: false) ⇒ 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.
This method returns an undefined value.
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 |
# File 'exceptions.rb', line 506 def dump(verbose: false) puts if verbose require "system_config" require "build_environment" ohai "Formula" puts "Tap: #{formula.tap}" if formula.tap? puts "Path: #{formula.path}" ohai "Configuration" SystemConfig.dump_verbose_config ohai "ENV" BuildEnvironment.dump env puts onoe "#{formula.full_name} #{formula.version} did not build" unless (logs = Dir["#{formula.logs}/*"]).empty? puts "Logs:" puts logs.map { |fn| " #{fn}" }.join("\n") end end if formula.tap if OS.not_tier_one_configuration? <<~EOS This is not a Tier 1 configuration: #{Formatter.url("https://docs.brew.sh/Support-Tiers")} #{Formatter.bold("Do not report any issues to Homebrew/* repositories!")} Read the above document instead before opening any issues or PRs. EOS elsif formula.tap.official? puts Formatter.error(Formatter.url(OS::ISSUES_URL), label: "READ THIS") elsif (issues_url = formula.tap.issues_url) puts <<~EOS If reporting this issue please do so at (not Homebrew/* repositories): #{Formatter.url(issues_url)} EOS else puts <<~EOS If reporting this issue please do so to (not Homebrew/* repositories): #{formula.tap} EOS end else <<~EOS We cannot detect the correct tap to report this issue to. Do not report this issue to Homebrew/* repositories! EOS end puts if issues.present? puts "These open issues may also help:" puts issues.map { |i| "#{i["title"]} #{i["html_url"]}" }.join("\n") end require "diagnostic" checks = Homebrew::Diagnostic::Checks.new checks.build_error_checks.each do |check| out = checks.send(check) next if out.nil? puts ofail out end end |
#fetch_issues ⇒ Array<T.untyped>
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.
496 497 498 499 500 501 502 503 |
# File 'exceptions.rb', line 496 def fetch_issues return [] if ENV["HOMEBREW_NO_BUILD_ERROR_ISSUES"].present? GitHub.issues_for_formula(formula.name, tap: formula.tap, state: "open", type: "issue") rescue GitHub::API::Error => e opoo "Unable to query GitHub for recent issues on the tap\n#{e.}" [] end |
#issues ⇒ Array<T.untyped>
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.
491 492 493 |
# File 'exceptions.rb', line 491 def issues @issues ||= fetch_issues end |