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

malcontent: add caveats #201714

Closed
wants to merge 1 commit into from
Closed

Conversation

egibs
Copy link
Contributor

@egibs egibs commented Dec 19, 2024

  • Have you followed the guidelines for contributing?
  • Have you ensured that your commits follow the commit style guide?
  • Have you checked that there aren't other open pull requests for the same formula update/change?
  • Have you built your formula locally with HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>, where <formula> is the name of the formula you're submitting?
  • Is your test running fine brew test <formula>, where <formula> is the name of the formula you're submitting?
  • Does your build pass brew audit --strict <formula> (after doing HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>)? If this is a new formula, does it pass brew audit --new <formula>?

This PR adds a more visible disclaimer re: AV detections when installing/running malcontent.

For more context: chainguard-dev/malcontent#727

@github-actions github-actions bot added the go Go use is a significant feature of the PR or issue label Dec 19, 2024
@egibs egibs force-pushed the add-malcontent-caveat branch from d461d0c to 615b0ff Compare December 19, 2024 01:51
Comment on lines +25 to +32
def caveats
<<~EOS
malcontent embeds Yara rules in order to scan files and
certain AV or anti-malware software may detect malcontent as malicious.
Programs that leverage Yara will generally see other programs that also use Yara as malicious
due to their respective strings looking for problematic behavior.
EOS
end
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the PR @egibs! Caveats are generally for issues specifically related to Homebrew packaging 1, so judging from chainguard-dev/malcontent#727 this may not be a good fit?

Footnotes

  1. https://docs.brew.sh/Formula-Cookbook#caveats

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Totally fair! We’ll rely on that messaging instead.

@egibs egibs closed this Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go Go use is a significant feature of the PR or issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants