xiki
xiki copied to clipboard
trogdoro
Homebrew formula for installation
Having a Homebrew installable version that's [easily] kept up to date would be awesome!
Back kickstarter and spread the word, and we'll get it done. It's going to be a close squeeze to get it to pass!
http://kck.st/1o5NLkb
Now that Mavericks has ruby 2.0, and xsh wraps the default terminal emacs (which also comes on Mavericks) this is pretty achievable.
--Craig
On Tue, Jul 8, 2014 at 2:31 PM, bvanalderweireldt [email protected] wrote:
+3
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-48402173.
I can't back it right now (SallieMae sucks!) but if I can help on docs or development I would love to!
but if I can help on docs or development I would love to!
Thanks!
Also, if you could tweet, invite people to facebook.com/xikirevolution, blog, and email people, that would be a huge help!
--Craig
On Wed, Jul 9, 2014 at 11:00 AM, Michael Weems [email protected] wrote:
I can't back it right now (SallieMae sucks!) but if I can help on docs or development I would love to!
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-48511026.
Anyone familiar with making homebrew recipes that wants to remote pair on this with me? The latest xiki installer is down to just a few steps, so it should be pretty cake to get it going.
--Craig
On Wed, Feb 18, 2015 at 8:44 AM, Geoff Longman [email protected] wrote:
[image: :+1:]
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-74898415.
I have no experience but would be willing to work with someone who is if needed.
I have written a lot of homebrew recipes in the past, and would be up for getting this working.
Cool, maybe we could pair together at some point on this. Though, the one-line installer works pretty well. I'm wondering if it's more trouble than it's worth having multiple ways of installing (if the install process changes, the recipe will need to be updated).
--Craig
On Wed, Apr 8, 2015 at 5:51 PM, André Arko [email protected] wrote:
I have written a lot of homebrew recipes in the past, and would be up for getting this working.
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91080410.
Hopefully the homebrew recipe will just invoke the installer script, right?
And I am literally holding off on installing xiki until I can install it into an isolated directory that I’m sure I can delete using homebrew. :)
On Apr 8, 2015, at 5:59 PM, Craig Muth [email protected] wrote:
Cool, maybe we could pair together at some point on this. Though, the one-line installer works pretty well. I'm wondering if it's more trouble than it's worth having multiple ways of installing (if the install process changes, the recipe will need to be updated).
--Craig
On Wed, Apr 8, 2015 at 5:51 PM, André Arko [email protected] wrote:
I have written a lot of homebrew recipes in the past, and would be up for getting this working.
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91080410.
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91081296.
Hopefully the homebrew recipe will just invoke the installer script, right?
When I started to go down the path of making a homebrew recipe, it seemed more complicated than that. Maybe a good first step is to just chat about what it would require. There's an old gem version of xiki that caused a lot of confusion - people would install xiki as a gem and install it by source, and there was a lot of confusion about which version was being used. Mabye there are things that could be done in homebrew that could mitigate this.
And I am literally holding off on installing xiki until I can install it into an isolated directory that I’m sure I can delete using homebrew. :)
The one-line installer (on xiki.com) puts everything into ~/xiki-master/. If you delete that (and the ~/xiki/ dir, where user customizations go), that's everything.
Homebrew is very friendly to unix conventions, and is really designed around ./configure --prefix=/foo && make && make install. If your installer script can accept a path to install to, the homebrew recipe will be about 5 lines.
As for the one-line installer putting everything in ~/xiki-master, that's great, but not how I want to manage software installed on my machine. :)
If your installer script can accept a path to install to,
There really is no installer. It's just a matter of extracting the tar to a dir, and adding this dir's bin dir to your path.
I'm remembering now... I started going down the path (I have a skeleton /usr/local/Library/Formula/xiki.rb file) but stopped short when I saw the homebrew guidelines that there should be a stable release. Xsh isn't super stable at this point. It'd be a little painful to have to make a new tag upon each bugfix, and update the recipe. Maybe in a few weeks though. In the mean time, it could be useful to remote pair on it, if you're open to it!
--Craig
On Wed, Apr 8, 2015 at 6:29 PM, André Arko [email protected] wrote:
Homebrew is very friendly to unix conventions, and is really designed around ./configure --prefix=/foo && make && make install. If your installer script can accept a path to install to, the homebrew recipe will be about 5 lines.
As for the one-line installer putting everything in ~/xiki-master, that's great, but not how I want to manage software installed on my machine. :)
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91085221.
The homebrew guidelines want a stable release to merge the recipe into the primary homebrew repository, but it’s super easy for you to provide your own unstable recipe in the meantime that can be installed via brew install URL. As soon as it stabilizes, submit that file in a pull request.
I’m happy to pair on it sometime (and it could even be in person, since I live in SF).
On Apr 8, 2015, at 9:53 PM, Craig Muth [email protected] wrote:
If your installer script can accept a path to install to,
There really is no installer. It's just a matter of extracting the tar to a dir, and adding this dir's bin dir to your path.
I'm remembering now... I started going down the path (I have a skeleton /usr/local/Library/Formula/xiki.rb file) but stopped short when I saw the homebrew guidelines that there should be a stable release. Xsh isn't super stable at this point. It'd be a little painful to have to make a new tag upon each bugfix, and update the recipe. Maybe in a few weeks though. In the mean time, it could be useful to remote pair on it, if you're open to it!
--Craig
On Wed, Apr 8, 2015 at 6:29 PM, André Arko [email protected] wrote:
Homebrew is very friendly to unix conventions, and is really designed around ./configure --prefix=/foo && make && make install. If your installer script can accept a path to install to, the homebrew recipe will be about 5 lines.
As for the one-line installer putting everything in ~/xiki-master, that's great, but not how I want to manage software installed on my machine. :)
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91085221.
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91114997.
provide your own unstable recipe in the meantime that can be installed via
brew install URL.
Great thought - that hadn't occurred to me.
I’m happy to pair on it sometime (and it could even be in person, since I live in SF).
Great, let's do it! Pinging you off-thread...
--Craig
On Wed, Apr 8, 2015 at 11:43 PM, André Arko [email protected] wrote:
The homebrew guidelines want a stable release to merge the recipe into the primary homebrew repository, but it’s super easy for you to provide your own unstable recipe in the meantime that can be installed via
brew install URL. As soon as it stabilizes, submit that file in a pull request.I’m happy to pair on it sometime (and it could even be in person, since I live in SF).
On Apr 8, 2015, at 9:53 PM, Craig Muth [email protected] wrote:
If your installer script can accept a path to install to,
There really is no installer. It's just a matter of extracting the tar to a dir, and adding this dir's bin dir to your path.
I'm remembering now... I started going down the path (I have a skeleton /usr/local/Library/Formula/xiki.rb file) but stopped short when I saw the homebrew guidelines that there should be a stable release. Xsh isn't super stable at this point. It'd be a little painful to have to make a new tag upon each bugfix, and update the recipe. Maybe in a few weeks though. In the mean time, it could be useful to remote pair on it, if you're open to it!
--Craig
On Wed, Apr 8, 2015 at 6:29 PM, André Arko [email protected] wrote:
Homebrew is very friendly to unix conventions, and is really designed around ./configure --prefix=/foo && make && make install. If your installer script can accept a path to install to, the homebrew recipe will be about 5 lines.
As for the one-line installer putting everything in ~/xiki-master, that's great, but not how I want to manage software installed on my machine. :)
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91085221.
— Reply to this email directly or view it on GitHub < https://github.com/trogdoro/xiki/issues/87#issuecomment-91114997>.
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-91128642.
So it looks like there's a place where formulas with master are totes ok.
https://github.com/Homebrew/homebrew-head-only
I tried my hand at building a formula, but ran into a wall with the interactive shell.
So, I think I've got a formula up on Homebrew/homebrew-head-only for review. I feel however, that I jumped the gun without consult. I am willing to fix the PR ASAP.
Here are some questions I should have asked beforehand:
- Is it ok to just pull from git vs. download the zip? (is there a difference)
- Would it be better to lock down availability to a release/tag?
- What is a good test to confirm that the installation succeeded?
To test my formula:
$ brew install --HEAD https://raw.githubusercontent.com/JosephViolago/homebrew-head-only/xiki/xiki.rb
I haven't gone through to make those decisions yet - it'll change over time. I have a homebrew formula and am waiting for Xiki to stablize to push it to homebrew.
The next version of Xiki will be quite a bit stabler and friendlier, and I'm going to make documentation a focus, and invite everyone else to join in on documenting stuff - xiki as well as shell commands in general! I'm making a central repo for xiki stuff, to avoid the pull request bottleneck.
--Craig
On Wed, Oct 28, 2015 at 6:46 PM, Joseph Violago [email protected] wrote:
To test my formula: $ brew install --HEAD https://raw.githubusercontent.com/JosephViolago/homebrew-head-only/xiki/xiki.rb
— Reply to this email directly or view it on GitHub https://github.com/trogdoro/xiki/issues/87#issuecomment-152049310.
Should I then close my PR?
Homebrew/homebrew-head-only is a formula repo that does not come out of box with homebrew. Those who do choose to add the repo are likely aware the risk of bleeding-edge. This documentation even disclaimers it.
https://github.com/Homebrew/homebrew-head-only/blob/master/README.md
I personally think it's ok to have xiki available in head-only for now.
Should I then close my PR?
Hmm, I don't want to encourage new users to try Xiki until I get the much improved next version out there (apologies for that). But if few people are going to notice it in homebrew-head-only, it could be good to try it out. Might as well leave it open, as long as we make sure it doesn't get moved to the main homebrew repo.
Is it ok to just pull from git vs. download the zip? (is there a difference)
There's no difference. The zip is autogenerated by github from master HEAD.
Would it be better to lock down availability to a release/tag?
Eventually probably yes, but for initial testing grabbing master HEAD is probably fine.
What is a good test to confirm that the installation succeeded?
This is what I had:
test do system "#{bin}/xsh --version" end
Other than that, my formula (created with the help of @indirect) was pretty similar to yours.
--Craig
On Thu, Oct 29, 2015 at 10:27 AM, Joseph Violago [email protected] wrote:
Should I then close my PR?
Homebrew/homebrew-head-only is a formula repo that does not come out of box with homebrew. Those who do choose to add the repo are likely aware the risk of bleeding-edge. This documentation even disclaimers it.
https://github.com/Homebrew/homebrew-head-only/blob/master/README.md
I personally think it's ok to have xiki available in head-only for now.
— Reply to this email directly or view it on GitHub.
Thanks for the response!
I've been doing some back and forth with failing builds over on the PR. Homebrew audit is complaining about /usr/local/Cellar/xiki/HEAD/lib/xiki.rb in the #{keg}/lib directory.
I think a quick & dirty solution would be to rename the directory in xiki /lib --> /src and changing it in the code accordingly. Thoughts?