Skip to content

ksail 3.1.0 (new formula) #228531

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

devantler
Copy link

  • 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>?

@github-actions github-actions bot added autosquash Automatically squash pull request commits according to Homebrew style. new formula PR adds a new formula to Homebrew/homebrew-core labels Jun 29, 2025
Copy link
Contributor

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.

@github-actions github-actions bot added autosquash Automatically squash pull request commits according to Homebrew style. and removed autosquash Automatically squash pull request commits according to Homebrew style. labels Jun 29, 2025
@github-actions github-actions bot added autosquash Automatically squash pull request commits according to Homebrew style. and removed autosquash Automatically squash pull request commits according to Homebrew style. labels Jun 29, 2025
Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>
@github-actions github-actions bot removed the autosquash Automatically squash pull request commits according to Homebrew style. label Jun 29, 2025
@SMillerDev
Copy link
Member

We frown on authors submitting their own work unless it is very popular.

https://docs.brew.sh/Acceptable-Formulae#niche-or-self-submitted-stuff

Comment on lines +27 to +41
def install
if OS.mac?
if Hardware::CPU.arm?
bin.install "ksail-darwin-arm64" => "ksail"
elsif Hardware::CPU.intel?
bin.install "ksail-darwin-amd64" => "ksail"
end
elsif OS.linux?
if Hardware::CPU.arm?
bin.install "ksail-linux-arm64" => "ksail"
elsif Hardware::CPU.intel?
bin.install "ksail-linux-amd64" => "ksail"
end
end
end
Copy link
Member

Choose a reason for hiding this comment

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

end

test do
system bin/"ksail", "--version"
Copy link
Member

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.

@devantler
Copy link
Author

We frown on authors submitting their own work unless it is very popular.

https://docs.brew.sh/Acceptable-Formulae#niche-or-self-submitted-stuff

Hi @SMillerDev 👋🏻

How is popularity typically determined in these cases? :-) I’ve been trying to push it past the recommended number of stars with the aim of resubmitting it to homebrew-core ("be known," e.g. GitHub repositories should have ≥30 forks, ≥30 watchers, or ≥75 stars). It’s a bit tricky to know when this kind of thing is frowned upon or not, given the project currently has 97 stars.

If you feel it’s still not ready for submission on that basis, I’d rather aim for a more concrete target before resubmitting and addressing the other comments :-)

@SMillerDev
Copy link
Member

Very popular (as the requirement for self-submitted) for me would be when tech journalists start writing about it and there's a lot of buzz online.
Popular enough to be merged at all is 75 stars and 30 watchers and forks.

@devantler
Copy link
Author

Very popular (as the requirement for self-submitted) for me would be when tech journalists start writing about it and there's a lot of buzz online. Popular enough to be merged at all is 75 stars and 30 watchers and forks.

Makes sense. If you are okay with merging given the star requirement, I would like to fix the issues pointed out. Otherwise I think we should close this PR, and wait to see if KSail gains more traction :-)

@daeho-ro daeho-ro marked this pull request as draft July 4, 2025 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new formula PR adds a new formula to Homebrew/homebrew-core
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants