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
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Formula/m/malcontent.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ def install
system "go", "build", *std_go_args(ldflags: "-s -w -X main.BuildVersion=#{version}", output: bin/"mal"), "./cmd/mal"
end

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
Comment on lines +25 to +32
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.


test do
assert_match version.to_s, shell_output("#{bin}/mal --version")

Expand Down
Loading