trying to add a software to homebrew for installing it via homebrew

[DiyorbekAzimqulov]

Output of brew config

HOMEBREW_VERSION: 4.1.4-40-g2cfea60
ORIGIN: https://github.com/Homebrew/brew
HEAD: 2cfea600d4bded2e59c4cb97dcb3b5805f3bc5e2
Last commit: 13 hours ago
Core tap origin: https://github.com/Homebrew/homebrew-core
Core tap HEAD: 746aa3c8df2586d4f2124a934be4e460246e2839
Core tap last commit: 10 hours ago
Core tap branch: master
Core tap JSON: 24 Jul 10:17 UTC
HOMEBREW_PREFIX: /opt/homebrew
HOMEBREW_CASK_OPTS: []
HOMEBREW_MAKE_JOBS: 8
Homebrew Ruby: 2.6.10 => /System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/bin/ruby
CPU: octa-core 64-bit arm_firestorm_icestorm
Clang: 14.0.0 build 1400
Git: 2.39.1 => /opt/homebrew/bin/git
Curl: 7.86.0 => /usr/bin/curl
macOS: 13.2.1-arm64
CLT: 14.2.0.0.1.1668646533
Xcode: N/A
Rosetta 2: false

Output of brew doctor

Warning: A newer Command Line Tools release is available.
Update them from Software Update in System Settings.

If that doesn't show you any updates, run:
  sudo rm -rf /Library/Developer/CommandLineTools
  sudo xcode-select --install

Alternatively, manually download them from:
  https://developer.apple.com/download/all/.
You should download the Command Line Tools for Xcode 14.3.


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

Warning: Some installed formulae are deprecated or disabled.
You should find replacements for the following formulae:
  proj@7

Warning: You have unlinked kegs in your Cellar.
Leaving kegs unlinked can lead to build-trouble and cause formulae that depend on
those kegs to fail to run properly once built. Run `brew link` on these:
  tcl-tk

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 /opt/homebrew/Library/Taps/homebrew/homebrew-core && git stash -u && git clean -d -f

Uncommitted files:
  ?? Formula/jprq.rb

Warning: Some taps are not on the default git origin branch and may not receive
updates. If this is a surprise to you, check out the default branch with:
  git -C $(brew --repo shivammathur/php) checkout master

Description of issue

I am currently trying to add software to install via homebrew. I have gone through the documentation of how to write formulae. the project is open-source and is installed by curl -fsSL https://jprq.io/install.sh | sudo bash. It has releases for individual os (mac, linux) and their respective architecture. It has also source code. I am wandering whether i need to build based on local machine's os and architecture or identify local machine's architecture and os and download pre-built package. I am new to packaging and exploring. Please help me so i become also an open-source maintainer. Any guide is appreciated. Here is steps i have takes so far:

# Documentation: https://docs.brew.sh/Formula-Cookbook
#                https://rubydoc.brew.sh/Formula
# PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!
class Jprq < Formula
  desc "Join Public Router, Quickly"
  homepage "https://jprq.io/"
  url "https://github.com/azimjohn/jprq/archive/refs/tags/2.1.tar.gz"
  sha256 "820a8509be252d4ca90eca1177e77f83f369332060661f53917d65aa65987888"
  license "Zlib"
  # 8e63f8fb62f2dd2f310bf619ab65c97d5dd1835d97cced5eb8cebddd293d2d06  jprq-darwin-amd64
  # acd19845a6484eee65db6f925b1d0244300831d4d5a37d147cc61e7e8c56775b  jprq-darwin-arm64

  def install
    
    # Download and extract the source code (if needed)
    system "curl", "-o", "source.tar.gz", "-L", "#{url}"
    system "tar", "-xf", "source.tar.gz"
    cd "jprq-2.1" # Adjust the directory name based on the extracted folder name
    system "sudo", "bash", "install.sh"
    system "./install.sh", *std_configure_args, "--disable-silent-rules"
  end 

  test do
    # `test do` will create, run in and delete a temporary directory.
    #
    # This test will fail and we won't accept that! For Homebrew/homebrew-core
    # this will need to be a test that verifies the functionality of the
    # software. Run the test with `brew test jprq`. Options passed
    # to `brew install` such as `--HEAD` also need to be provided to `brew test`.
    #
    # The installed folder is not in the path, so use the entire path to any
    # executables being tested: `system "#{bin}/program", "do", "something"`.
    system "false"
  end
end

i want to make jprq to be installable via home brew. I am stuck how these commands work and what to do.

[p-linnane]

All formulae in homebrew-core need to build from source. We do not accept pre-built binaries. When you submit the formula it will run on our CI and attempt to build for Linux x86_64, and the 3 most recent versions of macOS on both arm64 and x86_64.

For this specifically, you don't need to perofmr the curl and tar steps, those happen automatically. Running the install script will pull down prebuilt binaries, so that is also not needed. You most likely want to start with system "go", "build", *std_go_args(ldflags: "-s -w") and see if it throws errors.

[DiyorbekAzimqulov]

thank you. I did this

depends_on "go" => :build

  def install
    system "go", "build", *std_go_args(ldflags: "-s -w")
  end 

and here is the error output

==> Fetching jprq
==> Downloading https://github.com/azimjohn/jprq/archive/refs/tags/2.1.tar.gz
Already downloaded: /Users/diyorbekazimqulov/Library/Caches/Homebrew/downloads/328f1cca6a3e74afd6cb5e39c01a054c51b96c7f473f4e79ef56a9a07c6c2b60--jprq-2.1.tar.gz
==> Installing dependencies for jprq: go
==> Installing jprq dependency: go
==> Pouring go--1.21.0.arm64_ventura.bottle.tar.gz
🍺  /opt/homebrew/Cellar/go/1.21.0: 12,515 files, 241.0MB
==> Installing jprq
==> go build -ldflags=-s -w
Last 15 lines from /Users/diyorbekazimqulov/Library/Logs/Homebrew/jprq/01.go:
2023-08-14 18:53:50 +0000

go
build
-trimpath
-o=/opt/homebrew/Cellar/jprq/2.1/bin/jprq
-ldflags=-s -w

no Go files in /private/tmp/jprq-20230814-25769-x9lr55/jprq-2.1

READ THIS: https://docs.brew.sh/Troubleshooting

i can't figure out why this is happening

[alebcay]

It's because your main package is not in the root of the repo but rather in the cli directory. So instead of:

system "go", "build", *std_go_args(ldflags: "-s -w")

use:

system "go", "build", *std_go_args(ldflags: "-s -w"), "./cli"

to point to the cli directory.

Note that your repo seems to be missing a go.sum file so this may still fail. The recommended practice is that you commit the go.sum file and we require it to be present for software in the Homebrew core repo that pulls dependencies through Go modules.

[DiyorbekAzimqulov]

Thank you, I could build now.

[DiyorbekAzimqulov]

All formulae in homebrew-core need to build from source. We do not accept pre-built binaries. When you submit the formula it will run on our CI and attempt to build for Linux x86_64, and the 3 most recent versions of macOS on both arm64 and x86_64.

For this specifically, you don't need to perofmr the curl and tar steps, those happen automatically. Running the install script will pull down prebuilt binaries, so that is also not needed. You most likely want to start with system "go", "build", *std_go_args(ldflags: "-s -w") and see if it throws errors.

above comment also helped me to go in right direction. Thanks