Module: Kettle::Dev::CIHelpers

Defined in:
lib/kettle/dev/ci_helpers.rb

Overview

CI-related helper functions used by Rake tasks and release tooling.

This module only exposes module-functions (no instance state) and is intentionally small so it can be required by both Rake tasks and the kettle-release executable.

Class Method Summary collapse

Class Method Details

.current_branch ⇒ String?

Current git branch name, or nil when not in a repository.

Returns:

  • (String, nil) 


43
44
45
46
 
# File 'lib/kettle/dev/ci_helpers.rb', line 43

def current_branch
  out, status = Open3.capture2("git", "rev-parse", "--abbrev-ref", "HEAD")
  status.success? ? out.strip : nil
end

.current_head_sha ⇒ String?

Current git commit SHA, or nil when unavailable.

Returns:

  • (String, nil) 


50
51
52
53
 
# File 'lib/kettle/dev/ci_helpers.rb', line 50

def current_head_sha
  out, status = Open3.capture2("git", "rev-parse", "HEAD")
  status.success? ? out.strip : nil
end

.default_gitlab_token ⇒ String?

Default GitLab token from environment

Returns:

  • (String, nil) 


170
171
172
 
# File 'lib/kettle/dev/ci_helpers.rb', line 170

def default_gitlab_token
  ENV["GITLAB_TOKEN"] || ENV["GL_TOKEN"]
end

.default_token ⇒ String?

Default GitHub token sourced from environment.

Returns:

  • (String, nil) 


146
147
148
 
# File 'lib/kettle/dev/ci_helpers.rb', line 146

def default_token
  ENV["GITHUB_TOKEN"] || ENV["GH_TOKEN"]
end

.exclusions ⇒ Array<String>

List of workflow files to exclude from interactive menus and checks.

Returns:

  • (Array<String>) 


73
74
75
76
77
78
79
80
81
82
 
# File 'lib/kettle/dev/ci_helpers.rb', line 73

def exclusions
  %w[
    auto-assign.yml
    codeql-analysis.yml
    danger.yml
    dependency-review.yml
    discord-notifier.yml
    opencollective.yml
  ]
end

.failed?(run) ⇒ Boolean

Whether a run has completed with a non-success conclusion.

Parameters:

  • run (Hash, nil)

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/kettle/dev/ci_helpers.rb', line 140

def failed?(run)
  run && run["status"] == "completed" && run["conclusion"] && run["conclusion"] != "success"
end

.gitlab_failed?(pipeline) ⇒ Boolean

Whether a GitLab pipeline has failed

Parameters:

  • pipeline (Hash, nil)

Returns:

  • (Boolean) 


241
242
243
 
# File 'lib/kettle/dev/ci_helpers.rb', line 241

def gitlab_failed?(pipeline)
  pipeline && pipeline["status"] == "failed"
end

.gitlab_latest_pipeline(owner:, repo:, branch: nil, host: "gitlab.com", token: default_gitlab_token) ⇒ Hash{String=>String,Integer}?

Fetch the latest pipeline for a branch on GitLab

Parameters:

  • owner (String)
  • repo (String)
  • branch (String, nil) (defaults to: nil)
  • host (String) (defaults to: "gitlab.com")
  • token (String, nil) (defaults to: default_gitlab_token)

Returns:

  • (Hash{String=>String,Integer}, nil) 


181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/kettle/dev/ci_helpers.rb', line 181

def gitlab_latest_pipeline(owner:, repo:, branch: nil, host: "gitlab.com", token: default_gitlab_token)
  return unless owner && repo

  b = branch || current_branch
  return unless b

  project = URI.encode_www_form_component("#{owner}/#{repo}")
  uri = URI("https://#{host}/api/v4/projects/#{project}/pipelines?ref=#{URI.encode_www_form_component(b)}&per_page=1")
  req = Net::HTTP::Get.new(uri)
  req["User-Agent"] = "kettle-dev/ci-helpers"
  req["PRIVATE-TOKEN"] = token if token && !token.empty?
  res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
  return unless res.is_a?(Net::HTTPSuccess)

  data = JSON.parse(res.body)
  return unless data.is_a?(Array)

  pipe = data.first
  return unless pipe.is_a?(Hash)

  # Attempt to enrich with failure_reason by querying the single pipeline endpoint
  begin
    if pipe["id"]
      detail_uri = URI("https://#{host}/api/v4/projects/#{project}/pipelines/#{pipe["id"]}")
      dreq = Net::HTTP::Get.new(detail_uri)
      dreq["User-Agent"] = "kettle-dev/ci-helpers"
      dreq["PRIVATE-TOKEN"] = token if token && !token.empty?
      dres = Net::HTTP.start(detail_uri.hostname, detail_uri.port, use_ssl: true) { |http| http.request(dreq) }
      if dres.is_a?(Net::HTTPSuccess)
        det = JSON.parse(dres.body)
        pipe["failure_reason"] = det["failure_reason"] if det.is_a?(Hash)
        pipe["status"] = det["status"] if det["status"]
        pipe["web_url"] = det["web_url"] if det["web_url"]
      end
    end
  rescue => e
    Kettle::Dev.debug_error(e, __method__)
    # ignore enrichment errors; fall back to basic fields
  end
  {
    "status" => pipe["status"],
    "web_url" => pipe["web_url"],
    "id" => pipe["id"],
    "failure_reason" => pipe["failure_reason"]
  }
rescue => e
  Kettle::Dev.debug_error(e, __method__)
  nil
end

.gitlab_success?(pipeline) ⇒ Boolean

Whether a GitLab pipeline has succeeded

Parameters:

  • pipeline (Hash, nil)

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/kettle/dev/ci_helpers.rb', line 234

def gitlab_success?(pipeline)
  pipeline && pipeline["status"] == "success"
end

.latest_run(owner:, repo:, workflow_file:, branch: nil, token: default_token, require_head: false, head_sha: nil) ⇒ Hash{String=>String,Integer}?

Fetch latest workflow run info for a given workflow and branch via GitHub API.

Parameters:

  • owner (String)
  • repo (String)
  • workflow_file (String) —

    the workflow basename (e.g., “ci.yml”)

  • branch (String, nil) (defaults to: nil) —

    branch to query; defaults to #current_branch

  • token (String, nil) (defaults to: default_token) —

    OAuth token for higher rate limits; defaults to #default_token

Returns:

  • (Hash{String=>String,Integer}, nil) —

    minimal run info or nil on error/none



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
 
# File 'lib/kettle/dev/ci_helpers.rb', line 91

def latest_run(owner:, repo:, workflow_file:, branch: nil, token: default_token, require_head: false, head_sha: nil)
  return unless owner && repo

  b = branch || current_branch
  return unless b

  # Scope to the exact commit SHA when available to avoid picking up a previous run on the same branch.
  sha = head_sha || current_head_sha
  base_url = "https://api.github.com/repos/#{owner}/#{repo}/actions/workflows/#{workflow_file}/runs?branch=#{URI.encode_www_form_component(b)}&per_page=5"
  uri = URI(base_url)
  req = Net::HTTP::Get.new(uri)
  req["User-Agent"] = "kettle-dev/ci-helpers"
  req["Authorization"] = "token #{token}" if token && !token.empty?
  res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
  return unless res.is_a?(Net::HTTPSuccess)

  data = JSON.parse(res.body)
  runs = Array(data["workflow_runs"]) || []
  # Try to match by head_sha first; fall back to first run (branch-scoped) if none matches yet.
  run = if sha
    match = runs.find { |r| r["head_sha"] == sha }
    require_head ? match : (match || runs.first)
  else
    runs.first unless require_head
  end
  return unless run

  {
    "status" => run["status"],
    "conclusion" => run["conclusion"],
    "html_url" => run["html_url"],
    "id" => run["id"],
    "head_sha" => run["head_sha"]
  }
rescue => e
  Kettle::Dev.debug_error(e, __method__)
  nil
end

.origin_url ⇒ String?

Raw origin URL string from git config

Returns:

  • (String, nil) 


154
155
156
157
 
# File 'lib/kettle/dev/ci_helpers.rb', line 154

def origin_url
  out, status = Open3.capture2("git", "config", "--get", "remote.origin.url")
  status.success? ? out.strip : nil
end

.parse_hosted_repo(url, host) ⇒ Array(String, String)?

Parse owner/repo from common hosted Git remote URL shapes.

Parameters:

  • url (String, nil)
  • host (String)

Returns:

  • (Array(String, String), nil) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/kettle/dev/ci_helpers.rb', line 249

def parse_hosted_repo(url, host)
  return unless url

  if url =~ %r{\Agit@#{Regexp.escape(host)}:(.+?)/(.+?)(?:\.git)?\z}
    return [Regexp.last_match(1), Regexp.last_match(2).sub(/\.git\z/, "")]
  end

  uri = URI.parse(url)
  return unless uri.host == host

  path = uri.path.to_s.sub(%r{\A/}, "")
  owner, repo = path.split("/", 2)
  return unless owner && repo && !owner.empty? && !repo.empty?

  [owner, repo.sub(/\.git\z/, "")]
rescue URI::InvalidURIError
  nil
end

.project_root ⇒ String

Determine the project root directory.

Returns:

  • (String) —

    absolute path to the project root



21
22
23
24
25
26
27
28
29
 
# File 'lib/kettle/dev/ci_helpers.rb', line 21

def project_root
  # Too difficult to test every possible branch here, so ignoring
  # :nocov:
  dir = if defined?(Rake) && Rake&.application&.respond_to?(:original_dir)
    Rake.application.original_dir
  end
  # :nocov:
  dir || Dir.pwd
end

.repo_info ⇒ Array(String, String)?

Parse the GitHub owner/repo from the configured origin remote. Supports SSH and HTTPS remote URL forms.

Returns:

  • (Array(String, String), nil) —
    owner, repo

    or nil when unavailable



34
35
36
37
38
39
 
# File 'lib/kettle/dev/ci_helpers.rb', line 34

def repo_info
  out, status = Open3.capture2("git", "config", "--get", "remote.origin.url")
  return unless status.success?

  parse_hosted_repo(out.strip, "github.com")
end

.repo_info_gitlab ⇒ Array(String, String)?

Parse GitLab owner/repo from origin if pointing to gitlab.com

Returns:

  • (Array(String, String), nil) 


161
162
163
164
165
166
 
# File 'lib/kettle/dev/ci_helpers.rb', line 161

def repo_info_gitlab
  url = origin_url
  return unless url

  parse_hosted_repo(url, "gitlab.com")
end

.success?(run) ⇒ Boolean

Whether a run has completed successfully.

Parameters:

  • run (Hash, nil)

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/kettle/dev/ci_helpers.rb', line 133

def success?(run)
  run && run["status"] == "completed" && run["conclusion"] == "success"
end

.workflows_list(root = project_root) ⇒ Array<String>

List workflow YAML basenames under .github/workflows at the given root. Excludes maintenance workflows defined by #exclusions.

Parameters:

  • root (String) (defaults to: project_root) —

    project root (defaults to #project_root)

Returns:

  • (Array<String>) —

    sorted list of basenames (e.g., “ci.yml”)



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/kettle/dev/ci_helpers.rb', line 59

def workflows_list(root = project_root)
  workflows_dir = File.join(root, ".github", "workflows")
  files = if Dir.exist?(workflows_dir)
    Dir[File.join(workflows_dir, "*.yml")] + Dir[File.join(workflows_dir, "*.yaml")]
  else
    []
  end
  basenames = files.map { |p| File.basename(p) }
  basenames = basenames.uniq - exclusions
  basenames.sort
end