cantino / mcfly

Fly through your shell history. Great Scott!
MIT License
6.89k stars 178 forks source link

Brew installation: main repo or your tap? #217

Open gwerbin opened 2 years ago

gwerbin commented 2 years ago

The README for this project states that you can install it using a third-party Homebrew "tap". However, it is also in the main Homebrew repository: https://github.com/homebrew/homebrew-core/blob/master/Formula/mcfly.rb

Is there a reason to prefer the third-party tap over the version in Homebrew-Core?

cantino commented 2 years ago

That's a great question. I actually didn't know that someone had added it to the main Homebrew repository. I've always used a tap. Do you know what the process is to maintain the main repo version?

gwerbin commented 2 years ago

That's a great question. I actually didn't know that someone had added it to the main Homebrew repository. I've always used a tap. Do you know what the process is to maintain the main repo version?

You just need to submit a PR that bumps the version. They like to follow some specific contribution procedures (e.g. https://github.com/Homebrew/homebrew-core/blob/master/CONTRIBUTING.md and https://docs.brew.sh/Formula-Cookbook#commit) and there are also CLI tools that can help automate the process, like brew bump-formula-pr.

My local workflow is generally to symlink my Homebrew "cellar" to somewhere that's easy to access (e.g. ~/dev/packaging/homebrew-core) and make a new branch there. That way you don't need to brew update to test your changes. Just don't forget to switch your branch back to master when you're finished!

Aeron commented 2 years ago

It causes some version mismatches: at this point, an official repo has 0.5.13 available, while the tap has 0.6.0 already. And the instructions state to use brew install mcfly after tapping. That will install the version from the official repo, not from the tap. To install it properly, you need to use the brew install cantino/mcfly/mcfly command, referencing the tap directly.

cantino commented 2 years ago

Excellent point @Aeron, thank you. I've updated the readme.