Skip to content

How-To-Open-a-Homebrew-Pull-Request: clarify brew audit --new for new formulae#22063

Open
EoinTrial wants to merge 5 commits intoHomebrew:masterfrom
EoinTrial:docs/clarify-audit-new-flag
Open

How-To-Open-a-Homebrew-Pull-Request: clarify brew audit --new for new formulae#22063
EoinTrial wants to merge 5 commits intoHomebrew:masterfrom
EoinTrial:docs/clarify-audit-new-flag

Conversation

@EoinTrial
Copy link
Copy Markdown

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests (excluding integration tests) for your changes?
  • Have you successfully run brew lgtm with your changes locally?

  • AI was used to generate or assist with generating this PR. Claude Sonnet 4.6 (claude.ai) was used to identify the inconsistency between this page and Adding-Software-to-Homebrew.md. The one-line change was written and reviewed manually.

The guide currently shows brew audit --strict --online for changed formulae, which is correct. However, it doesn't distinguish this from the new formula case. A contributor adding a new formula following this guide would not know to use brew audit --new, which runs additional new-formula eligibility checks (and implies --strict and --online). This is already documented correctly in Adding-Software-to-Homebrew.md but the cross-reference is missing here.

Copy link
Copy Markdown
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I wonder if it makes sense to have --new referenced in the code block below. It may also make sense to recommend brew lgtm in this case; can you try that and see if it does the right thing here?

@EoinTrial
Copy link
Copy Markdown
Author

EoinTrial commented Apr 22, 2026

@MikeMcQuaid Thanks for taking a look! Have added a separate code block for new formulae using brew audit --new, and a brew lgtm recommendation. brew lgtm passes cleanly on the branch.

Copy link
Copy Markdown
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Not sure if all these work or correct but: think this would be the ideal state!

Comment thread docs/How-To-Open-a-Homebrew-Pull-Request.md Outdated
Comment thread docs/How-To-Open-a-Homebrew-Pull-Request.md Outdated
Comment thread docs/How-To-Open-a-Homebrew-Pull-Request.md Outdated
Comment thread docs/How-To-Open-a-Homebrew-Pull-Request.md Outdated
Comment thread docs/How-To-Open-a-Homebrew-Pull-Request.md Outdated
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
@EoinTrial
Copy link
Copy Markdown
Author

@MikeMcQuaid Thanks for your support with this - PR updated!

@MikeMcQuaid
Copy link
Copy Markdown
Member

@EoinTrial can you confirm that the changes I've suggested actually work as expected 😅? Also note the small CI failure 🔴 https://github.com/Homebrew/brew/actions/runs/24787486986/job/72535477934?pr=22063

@EoinTrial
Copy link
Copy Markdown
Author

EoinTrial commented Apr 22, 2026

@MikeMcQuaid Hey, when I tested locally, brew lgtm passed cleanly on my branch (typecheck passed, "No style checks are available for the changed files" as expected for a Markdown change, all tests passed).

brew style docs/How-To-Open-a-Homebrew-Pull-Request.md also reported no offenses. The CI markdown lint failure doesn't reproduce locally so maybe there's a pre-existing issue/environment flakiness?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants