Skip to content
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

Brew #46

Closed
ivan-burazin opened this issue May 31, 2024 · 15 comments · Fixed by #59
Closed

Brew #46

ivan-burazin opened this issue May 31, 2024 · 15 comments · Fixed by #59
Labels
enhancement New feature or request

Comments

@ivan-burazin
Copy link
Member

@idagelic can we get? brew install daytona so @osslate can update this everywhere?

@ivan-burazin ivan-burazin added the enhancement New feature or request label May 31, 2024
@idagelic
Copy link
Member

@idagelic can we get? brew install daytona so @osslate can update this everywhere?

@ivan-burazin please check Slack for this matter

@ivan-burazin
Copy link
Member Author

brew install daytona

@ivan-burazin
Copy link
Member Author

@idagelic brew install daytona/tap/daytonaio ? or some other shortener?

@idagelic
Copy link
Member

idagelic commented Jun 3, 2024

@ivan-burazin Can't get it shorter than that right now - until we resolve the issue stopping us from getting brew install daytona

Splitting it to two commands is an option:
brew tap daytonaio/daytona
brew install daytona
It's not really better for a "quick start", but a positive side is that you have then already "tapped" our repository and in the future brew upgrade daytona can be used to upgrade instead of needing to write brew upgrade daytonaio/daytona/daytona

@osslate
Copy link
Contributor

osslate commented Jun 4, 2024

@idagelic which is standard when it comes to brew? I can update the instructions in the installation guide if splitting in two is the "better" option.

Ideally since the docs are versioned, we should be instructing users to install the specific version of Daytona. Not sure if that's possible with brew; it's also a bit tricky with Nix.

@idagelic
Copy link
Member

idagelic commented Jun 4, 2024

@osslate Afaic we can keep it simply brew install daytonaio/daytona/daytona if someone wants to use brew.
There is currently no versioning even though that is possible within brew - we can document that when/if we switch to the official homebrew tap.

@ivan-burazin
Copy link
Member Author

What is the issues with TAP?

@idagelic
Copy link
Member

idagelic commented Jun 4, 2024

I don't understand your question

@ivan-burazin
Copy link
Member Author

why cant it be brew install daytonaio/tap/daytona instead of brew install daytonaio/daytona/daytona

@osslate
Copy link
Contributor

osslate commented Jun 4, 2024

As far as I understand, for illustration:

  • brew install <ORG>/<NAME>/<FORMULA>:
    1. Homebrew clones the repository at https://github.com/<ORG>/homebrew-<NAME>.git
    2. Homebrew imports the file <FORMULA>.rb in the cloned repository
    3. Homebrew builds and installs according to <FORMULA>.rb

How it currently works:

  • brew install daytonaio/daytona/daytona:
    1. Homebrew clones the repository at https://github.com/daytonaio/homebrew-daytona.git
    2. Homebrew imports the file daytona.rb in the cloned repository
    3. Homebrew builds and installs according to daytona.rb

And with the command you suggested:

  • brew install daytonaio/tap/daytona:
    1. Homebrew clones the repository at https://github.com/daytonaio/homebrew-tap.git
    2. Homebrew imports the file daytona.rb in the cloned repository
    3. Homebrew builds and installs according to daytona.rb

Because of how Homebrew works, it seems common practice to name repositories and formulas in the standard homebrew-<NAME> way. See the list of "interesting taps" on Homebrew's docs. You can see repos are in this format, e.g. homebrew-ffmpeg => brew install homebrew-ffmpeg/ffmpeg/ffmpeg

@idagelic
Copy link
Member

idagelic commented Jun 4, 2024

Thanks for the explanation @osslate

@ivan-burazin Yes, if we change the repository name from "homebrew-daytona" to "homebrew-tap", brew install daytonaio/tap/daytona would be possible. I didn't think of changing the repo name like that as I haven't seen anyone else do it - the part after "homebrew-" is usually the same as the app name in instances like ours where there is only one relevant package.

I just tried out this shortest option on my private acc: brew install idagelic/d/daytona and it works. Still, I don't know if I would go for this setup as it is not the standard

@osslate
Copy link
Contributor

osslate commented Jun 4, 2024

I'd opt to keep it as-is since it complies with Homebrew's standard. I'd also argue against changing the name as it'll break upgrades for people who've already done brew tap daytonaio/daytona, as the repository location will have changed.

This discussion is out of scope for docs though; @ivan-burazin if you believe it should be changed, I suggest opening an issue in either https://github.com/daytonaio/homebrew-daytona/ or https://github.com/daytonaio/daytona/. If it changes, we can update the docs.


From a docs perspective, do we want to keep the installation command as

brew install daytonaio/daytona/daytona

or split it in 2 and add upgrade instructions? i.e.

brew tap daytonaio/daytona
brew install daytona

@ivan-burazin
Copy link
Member Author

brew tap daytonaio/daytona
brew install daytona

Is fine but would like to shorten the brew install daytonaio/daytona/daytona - > brew install daytonaio/tap/daytona if there are no hard arguments against.

Lmk and will open a new issue on Daytona. thanks

@idagelic
Copy link
Member

idagelic commented Jun 5, 2024

@ivan-burazin No problem, please open up an issue and add a "discussion" tag

@idagelic
Copy link
Member

idagelic commented Jun 7, 2024

v0.18.0+ now live on brew install daytonaio/tap/daytona
Let me know if everything works correctly and I will close the issue.

Btw, you might have to run brew uninstall daytonaio/daytona/daytona first

osslate added a commit that referenced this issue Jun 11, 2024
* Installation procedures split into partials
* Installation guide split into sections based on OS (Linux, macOS,
  Windows)
* Added uninstall/upgrade instructions for Homebrew
* Added uninstall instructions for official method

Fixes #54, fixes #46, fixes #45.

Signed-off-by: Fionn Kelleher <[email protected]>
osslate added a commit that referenced this issue Jun 19, 2024
* Installation procedures split into partials
* Installation guide split into sections based on OS (Linux, macOS,
  Windows)
* Added uninstall/upgrade instructions for Homebrew
* Added uninstall instructions for official method

Fixes #54, fixes #46, fixes #45.
osslate added a commit that referenced this issue Jun 19, 2024
* Installation procedures split into partials
* Installation guide split into sections based on OS (Linux, macOS,
  Windows)
* Added uninstall/upgrade instructions for Homebrew
* Added uninstall instructions for official method

Fixes #54, fixes #46, fixes #45.

Signed-off-by: Fionn Kelleher <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants