Homebrew / homebrew-cask

🍻 A CLI workflow for the administration of macOS applications distributed as binaries
https://brew.sh
BSD 2-Clause "Simplified" License
20.95k stars 10.73k forks source link

Missing docs for :github_latest strategy #104626

Closed thatrobotdev closed 3 years ago

thatrobotdev commented 3 years ago

Hello! I've been noticing there are a lot of casks with a livecheck stanza that do this:

livecheck do
    url :url
    strategy :github_latest

but I can't find any docs for this in the livecheck stanza docs: https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/livecheck.md.

cho-m commented 3 years ago

Homebrew Cask docs probably need to be updated. EDIT: with Cask docs being migrated to central Homebrew docs (#104628), future documentation improvements will have to happen there.

A related issue was #98231, which was for documenting :git strategy.

Homebrew's core rubydoc (https://rubydoc.brew.sh/Homebrew/Livecheck/Strategy.html) lists all available strategies.

Some strategies used in Casks that aren't in the docs for Cask repo include:

carlocab commented 3 years ago

FYI, :github_latest should also only be used when really needed, as it involves an API call that is often rate-limited by GitHub.

github-actions[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.