Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

formula_cellar_checks: more granular mismatched_binary_allowlist #16944

Merged

Conversation

cho-m
Copy link
Member

@cho-m cho-m commented Mar 24, 2024

Add support for providing more granular glob patterns via the mismatched_binary_allowlist.json rather than an all-or-nothing option. This allows catching any unwanted binaries in new releases.

The glob patterns are assumed to be relative to the formula's prefix. Patterns are matched using fnmatch with flags for:

  • File::FNM_DOTMATCH to allow matching all files with **/*
  • File::FNM_EXTGLOB to behave like Dir.glob for {a,b}
  • File::FNM_PATHNAME to allow restricting * across directories

The original file format of ["<formula>"] should behave similar to {"<formula>": "**/*"}.

Also some changes to add type signature.

  • 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 for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

For an example, see homebrew-core PR: Homebrew/homebrew-core#167024

Add support for providing more granular glob patterns via the
mismatched_binary_allowlist.json rather than an all-or-nothing option.
This allows catching any unwanted binaries in new releases.

The glob patterns are assumed to be relative to the formula's prefix.
Patterns are matched using fnmatch with flags for:
* `File::FNM_DOTMATCH` to allow matching all files with `**/*`
* `File::FNM_EXTGLOB` to behave like `Dir.glob` for `{a,b}`
* `File::FNM_PATHNAME` to allow restricting `*` across directories

The original file format of `["<formula>"]` should behave similar to
`{"<formula>": "**/*"}`.

Also some changes to add type signature.

Signed-off-by: Michael Cho <michael@michaelcho.dev>
Copy link
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.

Good idea, thanks again @cho-m!

@MikeMcQuaid MikeMcQuaid merged commit 92a4311 into Homebrew:master Mar 24, 2024
25 checks passed
@cho-m cho-m deleted the mismatched_binary_allowlist-granular-globs branch March 24, 2024 22:58
@github-actions github-actions bot added the outdated PR was locked due to age label Apr 24, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants