brew/docs/Autobump.md
Anton Melnikov 75146e032c
docs: suggestions from code review
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2025-06-25 15:30:06 +02:00

1.5 KiB

last_review_date
last_review_date
2025-06-16

Autobump

BrewTestBot automatically checks for available updates of packages that are in Homebrew's "autobump list" for official repositories. These packages should not have to be bumped (i.e versions increased) manually by a contributor. Instead, every 3 hours a GitHub Action opens a new pull request to upgrade to the latest version of a formula/cask, if needed.

Excluding packages from autobumping

By default, all new formulae and casks from Homebrew/core and Homebrew/cask repositories are autobumped. To exclude a package from being autobumped, it must:

  1. have a deprecate! or disable! call
  2. have a livecheck do block containing a skip call
  3. has no no_autobump! call

There are other formula or cask-specific reasons listed in the Formula Cookbook and Cask Cookbook respectively.

To use no_autobump!, a reason for exclusion must be provided. We prefer use of one of the supported symbols. These can be found in the NO_AUTOBUMP_REASONS_LIST.

The reasons can be specified by their symbols:

no_autobump! because: :bumped_by_upstream

If none of the existing reasons fit, a custom reason can be provided as a string:

no_autobump! because: "some unique reason"

If there are multiple packages with a similar custom reason, it be added to NO_AUTOBUMP_REASONS_LIST.