Need help writing my first formula and getting it merged

[dylanmtaylor]

Output of brew config

❯ brew config
HOMEBREW_VERSION: 4.4.19-77-g7ce65c2
ORIGIN: https://github.com/Homebrew/brew
HEAD: 7ce65c24a678b5323af75226adbc92218d49cfe8
Last commit: 34 hours ago
Branch: master
Core tap HEAD: 2f4c9b55339d109ce73f59ad31e5cb3988782985
Core tap last commit: 26 minutes ago
Core tap JSON: 03 Feb 01:43 UTC
HOMEBREW_PREFIX: /home/linuxbrew/.linuxbrew
HOMEBREW_CASK_OPTS: []
HOMEBREW_DISPLAY: :0
HOMEBREW_EDITOR: /usr/bin/nano
HOMEBREW_MAKE_JOBS: 32
HOMEBREW_SORBET_RUNTIME: set
SUDO_ASKPASS: /usr/bin/ksshaskpass
Homebrew Ruby: 3.3.7 => /var/home/linuxbrew/.linuxbrew/Homebrew/Library/Homebrew/vendor/portable-ruby/3.3.7/bin/ruby
CPU: 32-core 64-bit zen3
Clang: N/A
Git: 2.48.1 => /bin/git
Curl: 8.9.1 => /bin/curl
Kernel: Linux 6.12.10-202.bazzite.fc41.x86_64 x86_64 GNU/Linux
OS: Bazzite 41 (FROM Fedora Kinoite) (Holographic)
Host glibc: 2.40
/usr/bin/gcc: 14.2.1
/usr/bin/ruby: N/A
glibc: N/A
gcc@11: N/A
gcc: N/A
xorg: N/A

Output of brew doctor

❯ brew doctor
Please note that these warnings are just used to help the Homebrew maintainers
with debugging if you file an issue. If everything you use Homebrew for is
working fine: please don't worry or file an issue; just ignore this. Thanks!

Warning: Some installed kegs have no formulae!
This means they were either deleted or installed manually.
You should find replacements for the following formulae:
  scalr-cli

Warning: You have uncommitted modifications to Homebrew/homebrew-core.
If this is a surprise to you, then you should stash these modifications.
Stashing returns Homebrew to a pristine state but can be undone
should you later need to do so for some reason.
  cd /var/home/linuxbrew/.linuxbrew/Homebrew/Library/Taps/homebrew/homebrew-core && git stash -u && git clean -d -f

Uncommitted files:
  ?? Formula/s/scalr-cli.rb

Description of issue

I am hitting a CI error in Homebrew/homebrew-core#206361 that I'm not sure how to fix. The error relates to GitHub notability. Is this a hard requirement for acceptance? I think this PR is really close to ready.

[gromgit]

The error relates to GitHub notability. Is this a hard requirement for acceptance?

Not a Homebrew maintainer, but I can't recall the last time any formula was granted an exception from this requirement.

Also, I'm pretty sure the only test in your formula:

    assert_match "Usage", shell_output(bin/"scalr-cli")

won't pass muster in the core tap. Despite the doc note that "a bad test is better than no test at all", maintainers generally won't let this by either unless there's absolutely no other way to generate testable output that actually exercises core functionality. You might want to look at existing formulae for other infrastructure CLIs for guidance and inspiration.

Of course, none of the above apply if you host the formula in your own tap.

[dylanmtaylor]

The error relates to GitHub notability. Is this a hard requirement for acceptance?

Not a Homebrew maintainer, but I can't recall the last time any formula was granted an exception from this requirement.

Also, I'm pretty sure the only test in your formula:

    assert_match "Usage", shell_output(bin/"scalr-cli")

won't pass muster in the core tap. Despite the doc note that "a bad test is better than no test at all", maintainers generally won't let this by either unless there's absolutely no other way to generate testable output that actually exercises core functionality. You might want to look at existing formulae for other infrastructure CLIs for guidance and inspiration.

Of course, none of the above apply if you host the formula in your own tap.

I'm not convinced that I can exercise functionality as Scalr is a cloud hosted platform for infrastructure. Without setting up an account for homebrew there and making API calls into it using the CLI, it wouldn't be easy to test. The same logic would likely apply to AWS cli or azure/gcp CLI tooling. I do wonder if Scalr themselves would be okay with hosting a homebrew tap. They seem open source friendly...

[gromgit]

Without setting up an account for homebrew there and making API calls into it using the CLI, it wouldn't be easy to test.

Not familiar with Scalr, but a non-trivial local-only test might be to generate a config file and have the CLI validate it (or even throw an error that can be tested for). I think any test that exercises more code than "just print a static message and exit" would be considered favourably by Homebrew maintainers.