Add bundle install to jekyll new command #5237

ashmaroli · 2016-08-12T04:22:14Z

This PR proposes to extend the jekyll new command with following:

Automatically cd my_blog and initiate bundle install

After you run jekyll new my_blog the command shell automatically cd into the new directory and runs bundle install.
If bundler is not installed, an exception is raised gracefully.
The user may choose to skip 'bundle install' if they plan to edit their new gemfile and change the theme gem, or if they want to inspect the new directory before running the bundle install command by using the new switch --skip-bundle

ref: #5225

envygeeks · 2016-08-12T04:41:25Z

lib/jekyll/commands/new.rb

+
+        def bundle_install(path)
+          Jekyll::External.require_with_graceful_fail "bundler"
+          $stdout.print "\nRun 'bundle install' with default theme? (Y/N)  "


Please use the Jekyll Logger.

Jekyll logger inserts a newline at the end.. I proposed print to have gets on same line.
Is that fine?

ashmaroli · 2016-08-12T08:47:05Z

Add bundler as a runtime dependency to gemspec?

envygeeks · 2016-08-12T21:27:44Z

I don't think that's a good idea, that could lead to problems on a system.

parkr · 2016-08-22T23:21:58Z

Thanks for this PR! I'm not sure how I feel about this either. The current code is interactive, which I'm not such a big fan of. rails new always ran bundle install which I liked as a newcomer, but the Rails community is pretty different from the Jekyll community, I think. Not sure how I feel about this.

In general, we are headed in the direction of "always use bundler" so this isn't problematic from that perspective. But we should gracefully fail if bundler isn't available and mention that the user should run bundle install before running jekyll. 😄

ashmaroli · 2016-08-23T02:39:59Z

Hi @parkr, I'm pretty confused..

But we should gracefully fail if bundler isn't available

PR does that already..

mention that the user should run bundle install before running jekyll.

??
There wont be a Gemfile to run bundle against until jekyll new has been called.
Running bundle after blog install will install minima theme gem for first time users; update minima if necessary for existing customers on J3.2.
Running bundle interactively lets the user edit their Gemfile / view the installed directory contents before having a request sent to rubygems.org. Once they make their decision, the new theme has to be bundled before being served.

mattr- · 2016-09-09T15:12:30Z

I'm 👍 with the idea of running bundler when you create a new Jekyll site. Let's just run it all the time though, instead of asking the user if we should run it. I see no use case where a user would not want to run bundler after getting a new site.

ashmaroli · 2016-09-09T15:51:42Z

@mattr- Thanks for the +1. 😃

I see no use case where a user would not want to run bundler after getting a new site.

I mentioned a possible scenario in the PR desc.:
The user may choose to skip 'bundle install' if they plan to edit their new gemfile and change the theme gem, or if they want to inspect the new directory before running the bundle install command

mattr- · 2016-09-09T16:01:34Z

Those are technical use cases that I don't want to solve for, especially the directory inspection. While I expect that a large set of Jekyll's users are going to be on the more technical side, it's ridiculously easy to run bundle after we've done it as part of site generation after editing the Gemfile. I see where you're coming from on this, but I feel like it's only going to be used in a tiny set of cases and I'd rather come back and add it later if it's a highly requested feature.

ashmaroli · 2016-09-09T16:06:17Z

Okay. I'll modify the PR.

ghost · 2016-09-09T16:12:27Z

I'd prefer the simple option of an argument --no-bundler, there's no need to have an interactive prompt, Jekyll doesn't do this already for anything AFAIK. Other that that, 👍!

ashmaroli · 2016-09-12T05:27:16Z

Replaced interactive bundle with running bundle install by default. Can be skipped by using a switch
--skip_bundle

ashmaroli · 2016-09-12T07:07:10Z

lib/jekyll/commands/new.rb

+          Jekyll.logger.info "Running bundle install in #{path.cyan}..."
+          Dir.chdir(path) do
+            unless ENV["CI"] || ENV["TEST"] # skip `bundle` during local tests
+              system("bundle install")


I'd like to skip bundle install when running tests. Couldn't find the appropriate ENV key/value..

I don't know about all that but that should be system("bundle", "install")

Meh, actually, tbh, it doesn't matter. I mix the two anyways I wouldn't blame you if you don't care to change it either.

Doesn't really matter until you start passing arguments dynamically 😉 Although I do prefer the variadic argument form

it works.. so leaving it as is..
Thanks for the info, anyways 😃

@spudowiar it's that kind of terrible logic that leads to security issues in software. It always matters. Whether it works or not is irrelevant to the point, the statement stands and the option was left to leave it as is out of ease, not out of it "not mattering."

@envygeeks I'm saying that although you should always use the variadic form, in this case not changing it doesn't matter too much. I always use the variadic form

I would prefer system("bundle", "install") as well. You may also have to specify the BUNDLER_GEMFILE variable as well.

- automatically run `bundle install` from within the newly generated blog directory by default. - add a new switch to skip this default behaviour.

ashmaroli · 2016-09-13T03:35:44Z

@jekyll/ecosystem : Since, this PR adds bundle install by default, should script/default-site be modified to avoid switching directories and then executing bundle install, as well?

ashmaroli · 2016-09-13T03:41:11Z

Updates:

changed skip switch to --skip-bundle
system(bundle install) replaced with system("bundle", "install")
modified test/test_new_command to test bundle-install-action and skip-switch

ghost · 2016-09-13T05:59:00Z

lib/jekyll/commands/new.rb

+
+        def after_install(path, options = {})
+          Jekyll.logger.info "New jekyll site installed in #{path.cyan}."
+          Jekyll.logger.info "Bundle install skipped." if options["skip-bundle"]


Seems superfluous since --skip-bundle is an explicitly chosen command line option, unaffected by the environment in any way

parkr

This LGTM. Would love another review from someone in @jekyll/core or @benbalter.

benbalter · 2016-09-19T13:17:39Z

LGTM.

parkr · 2016-09-20T22:32:24Z

@jekyllbot: merge +minor

ashmaroli · 2016-09-21T02:10:48Z

TODO:

Update online documentation regarding this new feature. :
- add a para under Quickstart

/cc @DirtyF
Whatsay? Is there any other place I should update?
Or will it be updated alongwith the Release Notes for 3.3?

ashmaroli · 2016-09-21T02:57:49Z

@parkr et al, All those bundle (show) reports in test logs might get frustrating at some point in future..
Your opinion?

parkr · 2016-09-21T20:01:31Z

All those bundle (show) reports in test logs might get frustrating at some point in future..
Your opinion?

Yeah definitely. If you can capture those and output them using Jekyll.logger then our current capture_stdout should ensure they're not written to actual stdout.

DirtyF · 2016-09-21T21:20:03Z

@ashmaroli yeah, homepage snippet will also be affected by this change, be sure to reflect changes here too.

ashmaroli force-pushed the bundle2new branch from 7754b0b to 2a43283 Compare August 12, 2016 04:33

envygeeks reviewed Aug 12, 2016
View reviewed changes

ashmaroli force-pushed the bundle2new branch 3 times, most recently from 4e58e89 to a244819 Compare August 12, 2016 08:32

ashmaroli force-pushed the bundle2new branch from a244819 to 3a8a627 Compare August 18, 2016 08:19

ashmaroli mentioned this pull request Aug 21, 2016

Add --classic switch to 'jekyll new' command #5217

Closed

1 task

parkr added the needs-decision 🤔 label Aug 22, 2016

ashmaroli mentioned this pull request Sep 9, 2016

Jekyll's Philosophy #5342

Closed

ashmaroli force-pushed the bundle2new branch from e4ea8a9 to 5d483a7 Compare September 12, 2016 05:02

ashmaroli reviewed Sep 12, 2016
View reviewed changes

add bundle install to jekyll new

566b42b

- automatically run `bundle install` from within the newly generated blog directory by default. - add a new switch to skip this default behaviour.

ashmaroli force-pushed the bundle2new branch from 5d483a7 to 35ff8a9 Compare September 13, 2016 03:15

test bundle install and skipping it.

345f043

ashmaroli force-pushed the bundle2new branch from 35ff8a9 to 345f043 Compare September 13, 2016 03:23

jekyllbot assigned benbalter Sep 13, 2016

ghost reviewed Sep 13, 2016
View reviewed changes

parkr approved these changes Sep 16, 2016

View reviewed changes

benbalter approved these changes Sep 19, 2016

View reviewed changes

jekyllbot merged commit 504411e into jekyll:master Sep 20, 2016

jekyllbot added the enhancement label Sep 20, 2016

jekyllbot added a commit that referenced this pull request Sep 20, 2016

Update history to reflect merge of #5237 [ci skip]

262be85

parkr added this to the 3.3 milestone Sep 20, 2016

ashmaroli mentioned this pull request Sep 29, 2016

[docs] Update documentation regarding bundle install after jekyll new #5428

Merged

ashmaroli mentioned this pull request Oct 7, 2016

rake spec (script/test) outputs bundle commands #5463

Closed

ashmaroli mentioned this pull request Dec 15, 2016

add 'bundler' as a dependency #5660

Closed

jekyll locked and limited conversation to collaborators Jul 11, 2019

jekyllbot added the frozen-due-to-age label Jul 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add bundle install to jekyll new command #5237

Add bundle install to jekyll new command #5237

ashmaroli commented Aug 12, 2016 •

edited

envygeeks Aug 12, 2016

ashmaroli Aug 12, 2016 •

edited

ashmaroli commented Aug 12, 2016

envygeeks commented Aug 12, 2016

parkr commented Aug 22, 2016

ashmaroli commented Aug 23, 2016

mattr- commented Sep 9, 2016

ashmaroli commented Sep 9, 2016

mattr- commented Sep 9, 2016

ashmaroli commented Sep 9, 2016

ghost commented Sep 9, 2016

ashmaroli commented Sep 12, 2016 •

edited

ashmaroli Sep 12, 2016 •

edited

envygeeks Sep 12, 2016

envygeeks Sep 12, 2016

ghost Sep 12, 2016

ashmaroli Sep 12, 2016

envygeeks Sep 12, 2016

ghost Sep 12, 2016

parkr Sep 12, 2016

ashmaroli commented Sep 13, 2016

ashmaroli commented Sep 13, 2016

ghost Sep 13, 2016

parkr Sep 16, 2016

parkr left a comment

benbalter commented Sep 19, 2016

parkr commented Sep 20, 2016

ashmaroli commented Sep 21, 2016 •

edited

ashmaroli commented Sep 21, 2016

parkr commented Sep 21, 2016

DirtyF commented Sep 21, 2016

Add bundle install to jekyll new command #5237

Add bundle install to jekyll new command #5237

Conversation

ashmaroli commented Aug 12, 2016 • edited

Choose a reason for hiding this comment

ashmaroli Aug 12, 2016 • edited

Choose a reason for hiding this comment

ashmaroli commented Aug 12, 2016

envygeeks commented Aug 12, 2016

parkr commented Aug 22, 2016

ashmaroli commented Aug 23, 2016

mattr- commented Sep 9, 2016

ashmaroli commented Sep 9, 2016

mattr- commented Sep 9, 2016

ashmaroli commented Sep 9, 2016

ghost commented Sep 9, 2016

ashmaroli commented Sep 12, 2016 • edited

ashmaroli Sep 12, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashmaroli commented Sep 13, 2016

ashmaroli commented Sep 13, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parkr left a comment

Choose a reason for hiding this comment

benbalter commented Sep 19, 2016

parkr commented Sep 20, 2016

ashmaroli commented Sep 21, 2016 • edited

ashmaroli commented Sep 21, 2016

parkr commented Sep 21, 2016

DirtyF commented Sep 21, 2016

ashmaroli commented Aug 12, 2016 •

edited

ashmaroli Aug 12, 2016 •

edited

ashmaroli commented Sep 12, 2016 •

edited

ashmaroli Sep 12, 2016 •

edited

ashmaroli commented Sep 21, 2016 •

edited