[GH-ISSUE #286 ] macOS: Homebrew / brew support #221

https://goreleaser.com/customization/homebrew/

Author

Owner

@vielmetti commented on GitHub (Jul 17, 2022):

it looks like goreleaser has support for Homebrew taps, here:

A limitation, though:

"Note that GoReleaser does not generate a valid homebrew-core formula. The generated formulas are meant to be published as homebrew taps, and in their current form will not be accepted in any of the official homebrew repositories."

@vielmetti commented on GitHub (Jul 17, 2022): it looks like `goreleaser` has support for Homebrew taps, here: https://goreleaser.com/customization/homebrew/ A limitation, though: "Note that GoReleaser does not generate a valid homebrew-core formula. The generated formulas are meant to be published as [homebrew taps](https://docs.brew.sh/Taps.html), and in their current form will not be accepted in any of the official homebrew repositories."

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Nov 24, 2022):

I made a PR at https://github.com/Homebrew/homebrew-core/pull/116607. This currently only builds the CLI part without the server. Maybe later I can improve this to also handle the npm run build and install parts

@Moulick commented on GitHub (Nov 24, 2022): I made a PR at https://github.com/Homebrew/homebrew-core/pull/116607. This currently only builds the CLI part without the server. Maybe later I can improve this to also handle the npm run build and install parts

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Nov 24, 2022):

Very cool.

Is this only for macOS, or will it be available for Linux as well?

What was the issue when you tried the full server support? For macOS I don't officially support that, but if the build is also for Linux it'd be nice to build and install the server like that too. I know it's harder, due to CGO for SQLite, but it'd be sweet.

@binwiederhier commented on GitHub (Nov 24, 2022): Very cool. Is this only for macOS, or will it be available for Linux as well? What was the issue when you tried the full server support? For macOS I don't officially support that, but if the build is also for Linux it'd be nice to build and install the server like that too. I know it's harder, due to CGO for SQLite, but it'd be sweet.

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Nov 24, 2022):

We can support both MacOs and Linux in brew. Directly building the server on macOS does work (I tried and tested it). CGO should also be fine, not a problem for brew. The only challenge for me for the server is the npm part, not even that but just how to do it cleanly in homebrew's syntax and inbuilt functions aka this

mv build/index.html build/app.html \
  && rm -rf ../server/site \
  && mv build ../server/site \
  && rm ../server/site/config.js ../server/site/asset-manifest.json

@Moulick commented on GitHub (Nov 24, 2022): We can support both MacOs and Linux in brew. Directly building the server on macOS does work (I tried and tested it). CGO should also be fine, not a problem for brew. The only challenge for me for the server is the npm part, not even that but just how to do it cleanly in homebrew's syntax and inbuilt functions aka this ``` bash mv build/index.html build/app.html \ && rm -rf ../server/site \ && mv build ../server/site \ && rm ../server/site/config.js ../server/site/asset-manifest.json ```

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Nov 24, 2022):

Just tried brew on a Linux cloud machine. Cannot run brew install --build-from-source ntfy there. I think it'll only be available once https://github.com/Homebrew/homebrew-core/pull/116607 is merged and @BrewTestBot builds the bottles for :x86_64_linux. That's how I think it'll work comparing yq.rb and a couple other go based formula

@Moulick commented on GitHub (Nov 24, 2022): Just tried brew on a Linux cloud machine. Cannot run `brew install --build-from-source ntfy` there. I think it'll only be available once https://github.com/Homebrew/homebrew-core/pull/116607 is merged and @BrewTestBot builds the bottles for `:x86_64_linux`. That's how I think it'll work comparing `yq.rb` and a couple other `go` based formula

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Nov 24, 2022):

@binwiederhier is docs necessary for the server?

@Moulick commented on GitHub (Nov 24, 2022): @binwiederhier is docs necessary for the server?

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Nov 24, 2022):

Now I have achieved building web + server + cli in brew. but not the docs as now that needs python

@Moulick commented on GitHub (Nov 24, 2022): Now I have achieved building web + server + cli in brew. but not the docs as now that needs python

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Nov 24, 2022):

Awesome!

The docs are not required, but I'd like to include everything in the build. Do you have to build it from source? Can't you just pull down the binary dist tarball from GitHub and use that? Or is that now allowed in their policies?
You are largly copying commands from the Makefile, which means stuff will break if I ever change that. Is there a way to reuse build instructions from the Makefile?

@binwiederhier commented on GitHub (Nov 24, 2022): Awesome! 1. The docs are not required, but I'd like to include everything in the build. Do you have to build it from source? Can't you just pull down the binary dist tarball from GitHub and use that? Or is that now allowed in their policies? 2. You are largly copying commands from the Makefile, which means stuff will break if I ever change that. Is there a way to reuse build instructions from the Makefile?

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Nov 24, 2022):

I think it's a requirement by brew to have it compliable from source. Haven't seen any formula that downloads pre-built as far as I can see.
That's what one of the maintainers also suggested, to do the file wrangling inside makefile. I think we'll have to make a few changes in the Makefile to handle all the files and folders movement in make and the actual go, node, and python build in brew.

Ideally, if we can find any other project that is in brew and also is a node + go combo would make it much easier to reference changes

@Moulick commented on GitHub (Nov 24, 2022): 1. I think it's a requirement by brew to have it compliable from source. Haven't seen any formula that downloads pre-built as far as I can see. 2. That's what one of the maintainers also suggested, to do the file wrangling inside makefile. I think we'll have to make a few changes in the Makefile to handle all the files and folders movement in make and the actual go, node, and python build in brew. Ideally, if we can find any other project that is in brew and also is a node + go combo would make it much easier to reference changes

BreizhHardware commented

Author

Owner

@decadent commented on GitHub (Nov 25, 2022):

I think it's a requirement by brew to have it compilable from source.

One possible reason is that if anything changes between the OS versions, users need to compile the software from the source. Same goes for when any dependencies or necessary configurations differ from the default.

This can be seen with Brew's compiled ‘bottles’, as Brew only supports the latest MacOS version—unless some bottles are left around by chance.

@decadent commented on GitHub (Nov 25, 2022): > I think it's a requirement by brew to have it compilable from source. One possible reason is that if anything changes between the OS versions, users need to compile the software from the source. Same goes for when any dependencies or necessary configurations differ from the default. This can be seen with Brew's compiled ‘bottles’, as Brew only supports the latest MacOS version—unless some bottles are left around by chance.

BreizhHardware commented

Author

Owner

@AliCihan commented on GitHub (Jan 30, 2023):

hi @Moulick , thanks for your effort. is this addition work-in-progress or abandoned?

@AliCihan commented on GitHub (Jan 30, 2023): hi @Moulick , thanks for your effort. is this addition work-in-progress or abandoned?

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Jan 31, 2023):

I do intend to come back to this. I switched jobs around the end of November and hence got busy 😬. Meanwhile, if you have the capacity to take this, please feel free to help. The thing pending was essentially updating the Makefile to move build out from ntfy.rb to the makefile. Like the makefile needs to be invokable in a brew build environment with npm, go, sqlite etc
https://github.com/Homebrew/homebrew-core/pull/116607

@Moulick commented on GitHub (Jan 31, 2023): I do intend to come back to this. I switched jobs around the end of November and hence got busy 😬. Meanwhile, if you have the capacity to take this, please feel free to help. The thing pending was essentially updating the Makefile to move build out from `ntfy.rb` to the makefile. Like the makefile needs to be invokable in a brew build environment with npm, go, sqlite etc https://github.com/Homebrew/homebrew-core/pull/116607

BreizhHardware commented

Author

Owner

@AliCihan commented on GitHub (Jan 31, 2023):

unfortunately not :( but great that you mentioned this explicitly, maybe others with the required skills can help.

@AliCihan commented on GitHub (Jan 31, 2023): unfortunately not :( but great that you mentioned this explicitly, maybe others with the required skills can help.

BreizhHardware commented

Author

Owner

@nwithan8 commented on GitHub (Mar 14, 2023):

Just wanted to chime in, quickly patched together a formula (client-only, confirmed on MacOS, untested on Linux) in my personal tap (nwithan8/tap).

Was running into the same issue @Moulick was having when trying to compile the server-included CLI on MacOS.

@nwithan8 commented on GitHub (Mar 14, 2023): Just wanted to chime in, quickly patched together a formula (client-only, confirmed on MacOS, untested on Linux) in my personal tap (`nwithan8/tap`). Was running into the same issue @Moulick was having when trying to compile the server-included CLI on MacOS.

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Mar 14, 2023):

Just wanted to chime in, quickly patched together a formula (client-only, confirmed on MacOS, untested on Linux) in my personal tap (nwithan8/tap).

Awesome, is the tap something we could make public and/or include in this repo?

Was running into the same issue @Moulick was having when trying to compile the server-included CLI on MacOS.

As (I believe so) mentioned before, the macOS server is not officially supported, and I don't really want to support it. The Makefile instructions are only there to support iOS development.

@binwiederhier commented on GitHub (Mar 14, 2023): > Just wanted to chime in, quickly patched together a formula (client-only, confirmed on MacOS, untested on Linux) in my personal tap (nwithan8/tap). Awesome, is the tap something we could make public and/or include in this repo? > Was running into the same issue @Moulick was having when trying to compile the server-included CLI on MacOS. As (I believe so) mentioned before, the macOS server is not officially supported, and I don't really want to support it. The Makefile instructions are only there to support iOS development.

BreizhHardware commented

Author

Owner

@nwithan8 commented on GitHub (Mar 14, 2023):

Awesome, is the tap something we could make public and/or include in this repo?

Absolutely, it's the same as the one I submitted to pcopy. I'll make a PR for adding it to the README, let me confirm it works on Linux first though.

@nwithan8 commented on GitHub (Mar 14, 2023): > Awesome, is the tap something we could make public and/or include in this repo? Absolutely, it's the same as the one I submitted to `pcopy`. I'll make a PR for adding it to the README, let me confirm it works on Linux first though.

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Mar 14, 2023):

Help me out here, you submitted a thing in the README for pcopy, but I meant to actually merge the source of the "tap" to the repo. I also cannot find it on brew.sh at all. But then I don't know how homebrew works at all .... Excuse my ignorance.

@binwiederhier commented on GitHub (Mar 14, 2023): Help me out here, you submitted a thing in the README for pcopy, but I meant to actually merge the source of the "tap" to the repo. I also cannot find it on brew.sh at all. But then I don't know how homebrew works at all .... Excuse my ignorance.

BreizhHardware commented

Author

Owner

@nwithan8 commented on GitHub (Mar 14, 2023):

Help me out here, you submitted a thing in the README for pcopy, but I meant to actually merge the source of the "tap" to the repo. I also cannot find it on brew.sh at all. But then I don't know how homebrew works at all .... Excuse my ignorance.

You're all good.

It would be easiest probably if you had your own tap, and was able to "push" updates to your projects into your own tap via GoReleaser and GitHub Actions.

Instead, in the meantime, I set up my tap to "pull" updates from a couple GitHub projects that don't have brew formula, including this and pcopy.

I believe @Moulick was trying to build a brew formula for this and get it merged into the official Homebrew repo, which has a lot stricter regulations around what gets approved and what doesn't. I took the easy way out with a third-party tap to avoid that PR nightmare process. Although yes, the eventual goal should be to get this merged into Homebrew Core and retire it from my third-party tap.

If you do go about setting up your own tap, by all means, feel free to take the formula I've already made, but you could also start over fresh and automated with something like Homebrew Releaser.

@nwithan8 commented on GitHub (Mar 14, 2023): > Help me out here, you submitted a thing in the README for pcopy, but I meant to actually merge the source of the "tap" to the repo. I also cannot find it on brew.sh at all. But then I don't know how homebrew works at all .... Excuse my ignorance. You're all good. It would be easiest probably if you [had your own tap](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap), and was able to "push" updates to your projects into your own tap via GoReleaser and GitHub Actions. Instead, in the meantime, I set up [my tap](https://github.com/nwithan8/homebrew-tap) to "pull" updates from a couple GitHub projects that don't have brew formula, including this and `pcopy`. I believe @Moulick was trying to build a brew formula for this and get it merged into [the official Homebrew repo](https://github.com/Homebrew/homebrew-core/pull/116607), which has a lot stricter regulations around what gets approved and what doesn't. I took the easy way out with a third-party tap to avoid that PR nightmare process. Although yes, the eventual goal should be to get this merged into Homebrew Core and retire it from my third-party tap. If you do go about setting up your own tap, by all means, feel free to take [the formula I've already made](https://github.com/nwithan8/homebrew-tap/blob/master/formula/ntfy.rb), but you could also start over fresh and automated with something like [Homebrew Releaser](https://github.com/Justintime50/homebrew-releaser).

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Mar 15, 2023):

Thank you for the explanation. Now that I understand how it works (roughly), let's start with what you did for pcopy, and work our way towards something more official.

Btw, I tried it on Linux and this is what I get:

1 pheckel@plup ~ » brew tap nwithan8/tap
pheckel@plup ~ » brew install pcopy   
Warning: No available formula with the name "pcopy". Did you mean pcp?
==> Searching for similarly named formulae...
==> Formulae
pcp

To install pcp, run:
  brew install pcp

@binwiederhier commented on GitHub (Mar 15, 2023): Thank you for the explanation. Now that I understand how it works (roughly), let's start with what you did for pcopy, and work our way towards something more official. Btw, I tried it on Linux and this is what I get: ``` 1 pheckel@plup ~ » brew tap nwithan8/tap pheckel@plup ~ » brew install pcopy Warning: No available formula with the name "pcopy". Did you mean pcp? ==> Searching for similarly named formulae... ==> Formulae pcp To install pcp, run: brew install pcp ```

BreizhHardware commented

Author

Owner

@nwithan8 commented on GitHub (Apr 9, 2023):

Thank you for the explanation. Now that I understand how it works (roughly), let's start with what you did for pcopy, and work our way towards something more official.

Btw, I tried it on Linux and this is what I get:
1 pheckel@plup ~ » brew tap nwithan8/tap
pheckel@plup ~ » brew install pcopy   
Warning: No available formula with the name "pcopy". Did you mean pcp?
==> Searching for similarly named formulae...
==> Formulae
pcp

To install pcp, run:
  brew install pcp

Sorry for the late reply, have been meaning to circle back on this.

Odd that it didn't find pcopy after you added the tap. Perhaps a brew update or brew upgrade will pull in the package listing?

I originally was concerned that you were having issues with the build process on Linux (this brew formula, for both ntfy and pcopy actually pulls down the source code and compiles it to install it, rather than downloading the pre-compiled assets), but on re-read, that doesn't seem to be the problem. I double-checked the logic via your Makefiles, and it seems like the compile steps will work on both Linux and MacOS (still, I have enhanced the formulas to allow for per-platform compile instructions in case those ever do deviate).

I haven't gotten a chance to test this on Linux, but I can confirm that both pcopy and ntfy install (download and compile) properly on MacOS from a fresh tap.

@nwithan8 commented on GitHub (Apr 9, 2023): > Thank you for the explanation. Now that I understand how it works (roughly), let's start with what you did for pcopy, and work our way towards something more official. > > Btw, I tried it on Linux and this is what I get: > > ``` > 1 pheckel@plup ~ » brew tap nwithan8/tap > pheckel@plup ~ » brew install pcopy > Warning: No available formula with the name "pcopy". Did you mean pcp? > ==> Searching for similarly named formulae... > ==> Formulae > pcp > > To install pcp, run: > brew install pcp > ``` Sorry for the late reply, have been meaning to circle back on this. Odd that it didn't find `pcopy` after you added the tap. Perhaps a `brew update` or `brew upgrade` will pull in the package listing? I originally was concerned that you were having issues with the build process on Linux (this brew formula, for both `ntfy` and `pcopy` actually pulls down the source code and compiles it to install it, rather than downloading the pre-compiled assets), but on re-read, that doesn't seem to be the problem. I double-checked the logic via your Makefiles, and it seems like the compile steps will work on both Linux and MacOS (still, I have enhanced the formulas to allow for per-platform compile instructions in case those ever do deviate). I haven't gotten a chance to test this on Linux, but I can confirm that both `pcopy` and `ntfy` install (download and compile) properly on MacOS from a fresh tap.

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Apr 9, 2023):

I created a new PR https://github.com/Homebrew/homebrew-core/pull/127927. This will at least get the ntfy client only build into the official homebrew-core. To add the client+server+web+docs for linux brew needs more work

@Moulick commented on GitHub (Apr 9, 2023): I created a new PR https://github.com/Homebrew/homebrew-core/pull/127927. This will at least get the ntfy client only build into the official homebrew-core. To add the client+server+web+docs for linux brew needs more work

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Apr 9, 2023):

Well, it's finally merged, now everyone can do brew install ntfy to get the ntfy cli, both on MacOS and Linux 🎉 🥳. Let's open a separate issue for enhancing the installation to also include docs + web + server?

Well, actually adding the server including CGO + SQlite is not difficult, it's the web interface and docs that make it complicated.

@Moulick commented on GitHub (Apr 9, 2023): Well, it's finally merged, now everyone can do `brew install ntfy` to get the ntfy cli, both on MacOS and Linux 🎉 🥳. Let's open a separate issue for enhancing the installation to also include docs + web + server? Well, actually adding the server including CGO + SQlite is not difficult, it's the web interface and docs that make it complicated.

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Apr 11, 2023):

That is fantastic news. Thank you for your effort. I'll update the install docs.

@binwiederhier commented on GitHub (Apr 11, 2023): That is fantastic news. Thank you for your effort. I'll update the install docs.

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Apr 11, 2023):

Awesome, great work. Added install instructions https://docs.ntfy.sh/install/#homebrew ❤️

@binwiederhier commented on GitHub (Apr 11, 2023): Awesome, great work. Added install instructions https://docs.ntfy.sh/install/#homebrew :heart:

BreizhHardware commented

Author

Owner

@AliCihan commented on GitHub (Apr 12, 2023):

Thanks a lot, everyone; it is working now.

@binwiederhier , will you close the issue, or is there anything else that needs to be done? I installed it directly with the brew command, and here is how it looks... is there anything else that I have to do in order to get it working?

~ % brew install ntfy
==> Fetching ntfy
==> Downloading https://ghcr.io/v2/homebrew/core/ntfy/manifests/2.3.1
######################################################################## 100.0%
==> Downloading https://ghcr.io/v2/homebrew/core/ntfy/blobs/sha256:d6528954737d2
==> Downloading from https://pkg-containers.githubusercontent.com/ghcr1/blobs/sh
######################################################################## 100.0%
==> Pouring ntfy--2.3.1.arm64_big_sur.bottle.tar.gz
🍺  /opt/homebrew/Cellar/ntfy/2.3.1: 6 files, 8.2MB
==> Running `brew cleanup ntfy`...
Disable this behaviour by setting HOMEBREW_NO_INSTALL_CLEANUP.
Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`).

~ % brew info ntfy
==> ntfy: stable 2.3.1 (bottled), HEAD
Send push notifications to your phone or desktop via PUT/POST
https://ntfy.sh/
/opt/homebrew/Cellar/ntfy/2.3.1 (6 files, 8.2MB) *
  Poured from bottle using the formulae.brew.sh API on 2023-04-12 at 18:08:47
From: https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/ntfy.rb
License: Apache-2.0 or GPL-2.0-only
==> Dependencies
Build: go ✘
==> Options
--HEAD
	Install HEAD version
==> Analytics
install: 0 (30 days), 0 (90 days), 35 (365 days)
install-on-request: 0 (30 days), 0 (90 days), 35 (365 days)
build-error: 0 (30 days)

@AliCihan commented on GitHub (Apr 12, 2023): Thanks a lot, everyone; it is working now. @binwiederhier , will you close the issue, or is there anything else that needs to be done? I installed it directly with the brew command, and here is how it looks... is there anything else that I have to do in order to get it working? ``` ~ % brew install ntfy ==> Fetching ntfy ==> Downloading https://ghcr.io/v2/homebrew/core/ntfy/manifests/2.3.1 ######################################################################## 100.0% ==> Downloading https://ghcr.io/v2/homebrew/core/ntfy/blobs/sha256:d6528954737d2 ==> Downloading from https://pkg-containers.githubusercontent.com/ghcr1/blobs/sh ######################################################################## 100.0% ==> Pouring ntfy--2.3.1.arm64_big_sur.bottle.tar.gz 🍺 /opt/homebrew/Cellar/ntfy/2.3.1: 6 files, 8.2MB ==> Running `brew cleanup ntfy`... Disable this behaviour by setting HOMEBREW_NO_INSTALL_CLEANUP. Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`). ~ % brew info ntfy ==> ntfy: stable 2.3.1 (bottled), HEAD Send push notifications to your phone or desktop via PUT/POST https://ntfy.sh/ /opt/homebrew/Cellar/ntfy/2.3.1 (6 files, 8.2MB) * Poured from bottle using the formulae.brew.sh API on 2023-04-12 at 18:08:47 From: https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/ntfy.rb License: Apache-2.0 or GPL-2.0-only ==> Dependencies Build: go ✘ ==> Options --HEAD Install HEAD version ==> Analytics install: 0 (30 days), 0 (90 days), 35 (365 days) install-on-request: 0 (30 days), 0 (90 days), 35 (365 days) build-error: 0 (30 days) ```

BreizhHardware commented

Author

Owner

@binwiederhier commented on GitHub (Apr 22, 2023):

I think that's more of a question for @Moulick

@binwiederhier commented on GitHub (Apr 22, 2023): I think that's more of a question for @Moulick

BreizhHardware commented

Author

Owner

@Moulick commented on GitHub (Apr 22, 2023):

I think nothing more to do, except if we want to bundle the docs + web + server for Linux builds

@Moulick commented on GitHub (Apr 22, 2023): I think nothing more to do, except if we want to bundle the docs + web + server for Linux builds

BreizhHardware commented