-
-
Notifications
You must be signed in to change notification settings - Fork 12.4k
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
vulnapi 0.8.0 (new formula) #192302
vulnapi 0.8.0 (new formula) #192302
Conversation
Thanks for contributing to Homebrew! 🎉 It looks like you're having trouble with a CI failure. See our contribution guide for help. You may be most interested in the section on dealing with CI failures. You can find the CI logs in the Checks tab of your pull request. |
on_macos do | ||
on_intel do | ||
url "https://github.com/cerberauth/vulnapi/releases/download/v0.8.0/vulnapi_Darwin_x86_64.tar.gz" | ||
sha256 "9df50027c130f7bd03d67f3c138e6f0e480e97c9dd577aad1b4789a88ea9bc2d" | ||
|
||
def install | ||
bin.install "vulnapi" | ||
end | ||
end | ||
on_arm do | ||
url "https://github.com/cerberauth/vulnapi/releases/download/v0.8.0/vulnapi_Darwin_arm64.tar.gz" | ||
sha256 "3648acba1dd0a9ec803e95243fe6c31ada7fc825306574ea99796875fa90e464" | ||
|
||
def install | ||
bin.install "vulnapi" | ||
end | ||
end | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs to build from source
assert_match "vulnapi version #{version}", shell_output("#{bin}/vulnapi version") | ||
assert_match "Usage", shell_output("#{bin}/vulnapi --help") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need a test that exercises the some of the functionality of the app. Version checks or usage checks (foo --version or foo --help) are not sufficient, as explained in the formula cookbook.
In most cases, a good test would involve running a simple test case: run #{bin}/foo input.txt.
- Then you can check that the output is as expected (with assert_equal or assert_match on the output of shell_output)
- You can also check that an output file was created, if that is expected: assert_predicate testpath/"output.txt", :exist?
Some advice for specific cases:
- If the formula is a library, compile and run some simple code that links against it. It could be taken from upstream's documentation / source examples.
- If the formula is for a GUI program, try to find some function that runs as command-line only, like a format conversion, reading or displaying a config file, etc.
- If the software cannot function without credentials, a test could be to try to connect with invalid credentials (or without credentials) and confirm that it fails as expected.
- Same if the software requires a virtual machine, docker instance, etc. to be running.
# typed: false | ||
# frozen_string_literal: true | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# typed: false | |
# frozen_string_literal: true |
Hi. Thanks for the PR. We have notability requirements for inclusion in homebrew-core (>30 forks, >30 watchers and >75 stars), which unfortunately this software does not meet. Please consider hosting this in your own Homebrew tap instead. |
HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>
, where<formula>
is the name of the formula you're submitting?brew test <formula>
, where<formula>
is the name of the formula you're submitting?brew audit --strict <formula>
(after doingHOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>
)? If this is a new formula, does it passbrew audit --new <formula>
?