admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

docs: apply suggestions from code review

Browse Source 
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
This commit is contained in:
AltCode 2025-08-07 14:25:20 +02:00
parent 360ff196c4
commit 58884c1fac
No known key found for this signature in database
3 changed files with 3 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Autobump.md
View File

@ -4,8 +4,6 @@ last_review_date: "2025-08-06"
# Autobump # Autobump
## Overview
In official repositories, [BrewTestBot](BrewTestBot.md) automatically checks for available updates to packages that are in Homebrew's "autobump list". These packages do not need to be bumped (i.e. have their version number increased) manually by a contributor. Instead, every 3 hours, a GitHub Action opens a new pull request to upgrade them to the latest version, if needed. In official repositories, [BrewTestBot](BrewTestBot.md) automatically checks for available updates to packages that are in Homebrew's "autobump list". These packages do not need to be bumped (i.e. have their version number increased) manually by a contributor. Instead, every 3 hours, a GitHub Action opens a new pull request to upgrade them to the latest version, if needed.
## Excluding packages from autobumping ## Excluding packages from autobumping
@ -22,12 +20,7 @@ Other formula and cask specific reasons for why a package is not autobumped are
When using `no_autobump!`, a reason for exclusion must be provided. When using `no_autobump!`, a reason for exclusion must be provided.
There are two ways to indicate the reason. The preferred way is to use a pre-existing symbol to indicate the reason. The available symbols are listed below and can be found in [`NO_AUTOBUMP_REASONS_LIST`](https://rubydoc.brew.sh/top-level-namespace.html#NO_AUTOBUMP_REASONS_LIST-constant): There are two ways to indicate the reason. The preferred way is to use a pre-existing symbol, which can be found in [`NO_AUTOBUMP_REASONS_LIST`](https://rubydoc.brew.sh/top-level-namespace.html#NO_AUTOBUMP_REASONS_LIST-constant), for example:
* `:incompatible_version_format`: the package has a version format that can only be updated manually
* `:bumped_by_upstream`: updates to the package are handled by the upstream developers
These reasons can be specified by their symbols:
```ruby ```ruby
no_autobump! because: :bumped_by_upstream no_autobump! because: :bumped_by_upstream

8
docs/Cask-Cookbook.md
View File

@ -648,7 +648,7 @@ Refer to the [`brew livecheck`](Brew-Livecheck.md) documentation for how to writ
The `no_autobump!` stanza excludes a cask from the autobump list. This means all updates are to be handled manually by submitting pull requests to the `Homebrew/homebrew-cask` repository. The `no_autobump!` stanza excludes a cask from the autobump list. This means all updates are to be handled manually by submitting pull requests to the `Homebrew/homebrew-cask` repository.
`no_autobump!` requires a reason to be provided with the `because:` paramater. It accepts a symbol that corresponds to a preset reason, for example: `no_autobump!` requires a reason to be provided with the `because:` paramater. It accepts a string or a symbol that corresponds to a preset reason, for example:
```ruby ```ruby
no_autobump! because: :incompatible_version_format no_autobump! because: :incompatible_version_format
@ -656,12 +656,6 @@ no_autobump! because: :incompatible_version_format
A complete list of allowed symbols can be found in [`NO_AUTOBUMP_REASONS_LIST`](https://rubydoc.brew.sh/top-level-namespace.html#NO_AUTOBUMP_REASONS_LIST-constant). A complete list of allowed symbols can be found in [`NO_AUTOBUMP_REASONS_LIST`](https://rubydoc.brew.sh/top-level-namespace.html#NO_AUTOBUMP_REASONS_LIST-constant).
A custom reason can also be provided if none of the available symbols fit, for example:
```ruby
no_autobump! because: "some unique reason"
```
Casks that use `strategy :extract_plist` in their `livecheck` block or have `version :latest` are always excluded from the autobump list and do not require `no_autobump!` to be declared. Casks that use `strategy :extract_plist` in their `livecheck` block or have `version :latest` are always excluded from the autobump list and do not require `no_autobump!` to be declared.
Refer to the [Autobump](Autobump.md) page for more information about the autobump process in Homebrew. Refer to the [Autobump](Autobump.md) page for more information about the autobump process in Homebrew.

8
docs/Formula-Cookbook.md
View File

@ -750,7 +750,7 @@ For `url`/`regex` guidelines and additional `livecheck` block examples, refer to
By default, all new formulae in the `Homebrew/homebrew-core` repository are autobumped. This means that future updates are handled automatically by Homebrew CI jobs, and contributors do not have to submit pull requests. By default, all new formulae in the `Homebrew/homebrew-core` repository are autobumped. This means that future updates are handled automatically by Homebrew CI jobs, and contributors do not have to submit pull requests.
Sometimes, we want to exclude a formula from this list, for one reason or another. This can be done by adding the `no_autobump!` method in the formula definition; a reason must be provided with the `because:` parameter. It accepts a symbol that corresponds to a preset reason, for example: Sometimes, we want to exclude a formula from this list, for one reason or another. This can be done by adding the `no_autobump!` method in the formula definition; a reason must be provided with the `because:` parameter. It accepts a string or a symbol that corresponds to a preset reason, for example:
```ruby ```ruby
no_autobump! because: :bumped_by_upstream no_autobump! because: :bumped_by_upstream
@ -758,12 +758,6 @@ no_autobump! because: :bumped_by_upstream
A complete list of allowed symbols can be found in [`NO_AUTOBUMP_REASONS_LIST`](https://rubydoc.brew.sh/top-level-namespace.html#NO_AUTOBUMP_REASONS_LIST-constant). A complete list of allowed symbols can be found in [`NO_AUTOBUMP_REASONS_LIST`](https://rubydoc.brew.sh/top-level-namespace.html#NO_AUTOBUMP_REASONS_LIST-constant).
A custom reason can also be provided if none of the available symbols fit, for example:
```ruby
no_autobump! because: "some unique reason"
```
See our [Autobump](Autobump.md) documentation for more information about the autobump process. See our [Autobump](Autobump.md) documentation for more information about the autobump process.
### URL download strategies ### URL download strategies