Skip to content

Commit 58884c1

Browse files
docs: apply suggestions from code review
Co-authored-by: Mike McQuaid <[email protected]>
1 parent 360ff19 commit 58884c1

File tree

3 files changed

+3
-22
lines changed

3 files changed

+3
-22
lines changed

docs/Autobump.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ last_review_date: "2025-08-06"
44

55
# Autobump
66

7-
## Overview
8-
97
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.
108

119
## Excluding packages from autobumping
@@ -22,12 +20,7 @@ Other formula and cask specific reasons for why a package is not autobumped are
2220

2321
When using `no_autobump!`, a reason for exclusion must be provided.
2422

25-
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):
26-
27-
* `:incompatible_version_format`: the package has a version format that can only be updated manually
28-
* `:bumped_by_upstream`: updates to the package are handled by the upstream developers
29-
30-
These reasons can be specified by their symbols:
23+
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:
3124

3225
```ruby
3326
no_autobump! because: :bumped_by_upstream

docs/Cask-Cookbook.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -648,20 +648,14 @@ Refer to the [`brew livecheck`](Brew-Livecheck.md) documentation for how to writ
648648

649649
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.
650650

651-
`no_autobump!` requires a reason to be provided with the `because:` paramater. It accepts a symbol that corresponds to a preset reason, for example:
651+
`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:
652652

653653
```ruby
654654
no_autobump! because: :incompatible_version_format
655655
```
656656

657657
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).
658658

659-
A custom reason can also be provided if none of the available symbols fit, for example:
660-
661-
```ruby
662-
no_autobump! because: "some unique reason"
663-
```
664-
665659
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.
666660

667661
Refer to the [Autobump](Autobump.md) page for more information about the autobump process in Homebrew.

docs/Formula-Cookbook.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -750,20 +750,14 @@ For `url`/`regex` guidelines and additional `livecheck` block examples, refer to
750750

751751
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.
752752

753-
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:
753+
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:
754754

755755
```ruby
756756
no_autobump! because: :bumped_by_upstream
757757
```
758758

759759
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).
760760

761-
A custom reason can also be provided if none of the available symbols fit, for example:
762-
763-
```ruby
764-
no_autobump! because: "some unique reason"
765-
```
766-
767761
See our [Autobump](Autobump.md) documentation for more information about the autobump process.
768762

769763
### URL download strategies

0 commit comments

Comments
 (0)