Class: Homebrew::DevCmd::Release Private

Inherits:
AbstractCommand show all
Defined in:
dev-cmd/release.rb,
sorbet/rbi/dsl/homebrew/dev_cmd/release.rbi

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.

Defined Under Namespace

Classes: Args

Instance Method Summary collapse

Methods inherited from AbstractCommand

command, command_name, dev_cmd?, #initialize, parser, ruby_cmd?

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

This class inherits a constructor from Homebrew::AbstractCommand

Instance Method Details

#args ⇒ Homebrew::DevCmd::Release::Args

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.

Returns:



10
 
# File 'sorbet/rbi/dsl/homebrew/dev_cmd/release.rbi', line 10

def args; end

#run ⇒ 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.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'dev-cmd/release.rb', line 37

def run
  safe_system "git", "-C", HOMEBREW_REPOSITORY, "fetch", "origin" if Homebrew::EnvConfig.no_auto_update?

  require "utils/github"

  begin
    latest_release = GitHub.get_latest_release "Homebrew", "brew"
  rescue GitHub::API::HTTPNotFoundError
    odie "No existing releases found!"
  end
  latest_version = Version.new latest_release["tag_name"]

  if args.major? || args.minor?
    one_month_ago = Date.today << 1
    latest_major_minor_release = begin
      GitHub.get_release "Homebrew", "brew", "#{latest_version.major_minor}.0"
    rescue GitHub::API::HTTPNotFoundError
      nil
    end

    if latest_major_minor_release.blank?
      opoo "Unable to determine the release date of the latest major/minor release."
    elsif Date.parse(latest_major_minor_release["published_at"]) > one_month_ago
      odie "The latest major/minor release was less than one month ago."
    end
  end

  new_version = if args.major?
    Version.new "#{latest_version.major.to_i + 1}.0.0"
  elsif args.minor?
    Version.new "#{latest_version.major}.#{latest_version.minor.to_i + 1}.0"
  else
    Version.new "#{latest_version.major}.#{latest_version.minor}.#{latest_version.patch.to_i + 1}"
  end.to_s

  if args.major? || args.minor?
    latest_major_minor_version = "#{latest_version.major}.#{latest_version.minor.to_i}.0"
    ohai "Release notes since #{latest_major_minor_version} for #{new_version} blog post:"
    # release notes without usernames, new contributors, or extra lines
    blog_post_notes = GitHub.generate_release_notes("Homebrew", "brew", new_version,
                                                    previous_tag: latest_major_minor_version)["body"]
    blog_post_notes = blog_post_notes.lines.filter_map do |line|
      next unless (match = line.match(/^\* (.*) by @[\w-]+ in (.*)$/))

      "- [#{match[1]}](#{match[2]})"
    end.sort
    puts blog_post_notes
  end

  ohai "Generating release notes for #{new_version}"
  release_notes = if args.major? || args.minor?
    "Release notes for this release can be found on the [Homebrew blog](https://brew.sh/blog/#{new_version}).\n"
  else
    ""
  end
  release_notes += GitHub.generate_release_notes("Homebrew", "brew", new_version,
                                                 previous_tag: latest_version)["body"]

  puts release_notes
  puts

  unless args.force?
    opoo "Use `brew release --force` to trigger the release workflow and create the draft release."
    return
  end

  # Get the current commit SHA
  current_sha = Utils.safe_popen_read("git", "-C", HOMEBREW_REPOSITORY, "rev-parse", "origin/main").strip
  release_workflow = "release.yml"

  dispatch_time = Time.now
  ohai "Triggering release workflow for #{new_version}..."
  begin
    GitHub.workflow_dispatch_event("Homebrew", "brew", release_workflow, "main", tag: new_version)
  # Cannot use `e` as Sorbet needs it used below instead.
  # rubocop:disable Naming/RescuedExceptionsVariableName
  rescue *GitHub::API::ERRORS => error
    odie "Unable to trigger workflow: #{error.message}!"
  end
  # rubocop:enable Naming/RescuedExceptionsVariableName

  # Poll for workflow completion
  initial_sleep_time = 15
  sleep_time = 5
  max_attempts = 60 # 5 minutes (5 seconds * 60 attempts)
  attempt = 0
  run_conclusion = T.let(nil, T.nilable(String))

  while attempt < max_attempts
    sleep attempt.zero? ? initial_sleep_time : sleep_time
    attempt += 1

    # Check workflow runs for the commit SHA
    begin
      runs_url = "#{GitHub::API_URL}/repos/Homebrew/brew/actions/workflows/#{release_workflow}/runs"
      response = GitHub::API.open_rest("#{runs_url}?event=workflow_dispatch&per_page=5")
      run = response["workflow_runs"]&.find do |r|
        r["head_sha"] == current_sha && Time.parse(r["created_at"]) >= dispatch_time
      end

      if run
        if run["status"] == "completed"
          run_conclusion = run["conclusion"]
          puts if attempt > 1
          break
        end

        if attempt == 1
          puts "This will take a few minutes. You can monitor progress at:"
          puts "  #{Formatter.url(run["html_url"])}"
          print "Waiting for workflow to complete..."
        else
          print "."
        end
      else
        puts
        odie "Unable to find workflow for commit: #{current_sha}!"
      end
    rescue *GitHub::API::ERRORS => e
      puts
      odie "Unable to check workflow status: #{e.message}!"
    end
  end

  odie "Workflow completed with status: #{run_conclusion}!" if run_conclusion != "success"

  puts
  ohai "Release created at:"
  release_url = "https://github.com/Homebrew/brew/releases"
  puts "  #{Formatter.url(release_url)}"
  exec_browser release_url
end