brew icon indicating copy to clipboard operation
brew copied to clipboard

docs: add autobump related documentation

Open botantony opened this issue 6 months ago • 3 comments

  • [x] Have you followed the guidelines in our Contributing document?
  • [x] Have you checked to ensure there aren't other open Pull Requests for the same change?
  • [x] Have you added an explanation of what your changes do and why you'd like us to include them?
  • [ ] Have you written new tests for your changes? Here's an example.
  • [x] Have you successfully run brew style with your changes locally?
  • [x] Have you successfully run brew typecheck with your changes locally?
  • [x] Have you successfully run brew tests with your changes locally?

The official repositories are ready to start using new autobump list instead of autobump.txt:

# `test_func` is a custom method that compares `autobump.txt` list with new one
# txt - current autobump list, `no_autobump!` - new one
brew(main):001> Tap.fetch("homebrew/cask").test_func
# Deprecated cask
txt - `no_autobump!`: ["teleport@16"] (size: 1)

# Missed this cask, oops
`no_autobump!` - txt: ["font-zpix"] (size: 1)

brew(main):002> Tap.fetch("homebrew/core").test_func
# Most of them are deprecated, disabled, have `skip` in `livecheck`, etc
txt - `no_autobump!`: ["ansible@10", "ares", "erlang@25", "gcc@13", "grafana-agent", "[email protected]", "jetty-runner", "[email protected]", "[email protected]", "[email protected]", "mise", "node@18", "pnpm@8", "pyside@2", "ruff-lsp", "service-weaver", "spidermonkey@115", "traefik@2", "wcurl"] (size: 19)

# recently added formulae
`no_autobump!` - txt: ["act_runner", "desed", "git-recent", "qrkey", "spice-server"] (size: 5)

I also added some info about the autobump list in the docs. Writing is not my strongest skill, so any suggestions are appreciated

botantony avatar Jun 15 '25 23:06 botantony

Does https://github.com/Homebrew/homebrew-cask/blob/56133fc1b108ad2ab7e6fecf16cde27e2ad288c7/.github/workflows/autobump.yml#L41 not still need to be updated?

Bo98 avatar Jun 16 '25 06:06 Bo98

Does https://github.com/Homebrew/homebrew-cask/blob/56133fc1b108ad2ab7e6fecf16cde27e2ad288c7/.github/workflows/autobump.yml#L41 not still need to be updated?

This action still have to be updated but it cannot be done without getting autobump list for API first (right now Tap.fetch("homebrew/cask").autobump returns list from autoubmp.txt file). Homebrew/core action is fine and should work without any changes

botantony avatar Jun 16 '25 06:06 botantony

This action still have to be updated but it cannot be done without getting autobump list for API first (right now Tap.fetch("homebrew/cask").autobump returns list from autoubmp.txt file). Homebrew/core action is fine and should work without any changes

Marking this PR as draft until there's a PR open to do this.

CC @Homebrew/maintainers to make sure this PR makes sense to you.

MikeMcQuaid avatar Jun 16 '25 07:06 MikeMcQuaid

Thanks @botantony!

MikeMcQuaid avatar Jun 25 '25 15:06 MikeMcQuaid