Class: Homebrew::Livecheck::Strategy::GithubLatest

Inherits:
Object
  • Object
show all
Extended by:
Homebrew::Livecheck::Strategic
Defined in:
livecheck/strategy/github_latest.rb

Overview

The GithubLatest strategy identifies versions of software at github.com by checking a repository's "latest" release using the GitHub API.

GitHub URLs take a few different formats:

  • https://github.com/example/example/releases/download/1.2.3/example-1.2.3.tar.gz
  • https://github.com/example/example/archive/v1.2.3.tar.gz
  • https://github.com/downloads/example/example/example-1.2.3.tar.gz

GithubLatest should only be used when the upstream repository has a "latest" release for a suitable version and the strategy is necessary or appropriate (e.g. the formula/cask uses a release asset or the Git strategy returns an unreleased version). The strategy can only be applied by using strategy :github_latest in a livecheck block.

The default regex identifies versions like 1.2.3/v1.2.3 in a release's tag or title. This is a common tag format but a modified regex can be provided in a livecheck block to override the default if a repository uses a different format (e.g. 1.2.3d, 1.2.3-4, etc.).

Constant Summary collapse

NICE_NAME = 
"GitHub - Latest"
PRIORITY =

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

A priority of zero causes livecheck to skip the strategy. We do this for Homebrew::Livecheck::Strategy::GithubLatest so we can selectively apply the strategy using strategy :github_latest in a livecheck block.

0

Class Method Summary collapse

Methods included from Homebrew::Livecheck::Strategic

find_versions, match?

Class Method Details

.find_versions(url:, regex: GithubReleases::DEFAULT_REGEX, options: Options.new, &block) ⇒ Hash{Symbol => T.anything}

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.

Generates the GitHub API URL for the repository's "latest" release and identifies the version from the JSON response.

Parameters:

  • url (String) —

    the URL of the content to check

  • regex (Regexp) (defaults to: GithubReleases::DEFAULT_REGEX) —

    a regex used for matching versions in content

  • options (Options) (defaults to: Options.new) —

    options to modify behavior

  • block (Proc, nil)

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'livecheck/strategy/github_latest.rb', line 87

def self.find_versions(url:, regex: GithubReleases::DEFAULT_REGEX, options: Options.new, &block)
  match_data = { matches: {}, regex:, url: }

  generated = generate_input_values(url)
  return match_data if generated.blank?

  match_data[:url] = generated[:url]

  release = GitHub.get_latest_release(generated[:username], generated[:repository])
  GithubReleases.versions_from_content(release, regex, &block).each do |match_text|
    match_data[:matches][match_text] = Version.new(match_text)
  end

  match_data
end

.generate_input_values(url) ⇒ Hash{Symbol => 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.

Extracts information from a provided URL and uses it to generate various input values used by the strategy to check for new versions. Some of these values act as defaults and can be overridden in a livecheck block.

Parameters:

  • url (String) —

    the URL used to generate values

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'livecheck/strategy/github_latest.rb', line 59

def self.generate_input_values(url)
  values = {}

  match = url.delete_suffix(".git").match(GithubReleases::URL_MATCH_REGEX)
  return values if match.blank?

  values[:url] = "https://api.github.com/repos/#{match[:username]}/#{match[:repository]}/releases/latest"
  values[:username] = match[:username]
  values[:repository] = match[:repository]

  values
end

.match?(url) ⇒ Boolean

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.

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String) —

    the URL to match against

Returns:

  • (Boolean) 


47
48
49
 
# File 'livecheck/strategy/github_latest.rb', line 47

def self.match?(url)
  GithubReleases.match?(url)
end