`bin/setup` script to bootstrap applications. #15189

senny · 2014-05-20T08:20:37Z

This is a first draft to collect feedback.

About

While this script does not perform much work out of the box, the idea is to have a starting point to add your own setup code. Having an automated way to bootstrap your application saves not only time but also serves as verifiable documentation. By default the script does:

bundle install
bin/rake db:setup

To encourage users to modify it, I included some suggestions what you might want to do.

Example

This Gist shows the output of the script for a newly generated application. Database setup fails because there is no schema present.

Work

document, where should this convention be documented?

pftg · 2014-05-20T08:39:26Z

👍

sgrif · 2014-05-20T15:16:27Z

Generated README seems like it'd be a good place to document it.

rafaelfranca · 2014-05-20T15:40:21Z

Yes. I usually put on the README in my applications

senny · 2014-05-20T19:09:47Z

I thought about the README. However I noticed that we don't document any conventions there at all. For example bin/rake for running tests. Should we add that as well?

rafaelfranca · 2014-05-20T19:12:09Z

Not sure. @fxn is the best person to talk about documentation.

dhh · 2014-05-22T14:08:35Z

railties/lib/rails/generators/rails/app/templates/bin/setup

Before even this, we should install bundler.

dhh · 2014-05-22T14:11:42Z

How are we dealing with error output? Will calling system show STDOUT stuff?

dhh · 2014-05-22T14:12:29Z

Otherwise I think this is a good start. We can merge it in.

senny · 2014-05-22T14:13:07Z

@dhh system does show the STDOUT.

fxn · 2014-05-22T14:18:05Z

Why does the script use pathname instead of a string?

fxn · 2014-05-22T14:25:11Z

Re: documenting this convention.

The generated README is a meta-README https://github.com/senny/rails/blob/bin/setup/railties/lib/rails/generators/rails/app/templates/README.rdoc.

READMEs depend so much on the project that I find hard that we can write anything specific and more helpful than that, although if anyone feels inspired and wants to give it a shot please feel free.

That was also why I was skeptical about bin/setup, it is a convention for just one in a number of steps whose content is too dependant on the project... going to be hard to settle on any initial contents there.

senny · 2014-05-22T14:25:42Z

@fxn I see the script as a starting point. Many operations will involve paths and Pathname is easy to work with. Also, Rails usually returns Pathname objects (eg. Rails.root).

fxn · 2014-05-22T14:27:42Z

Well, in my scripting I never use pathnames, string interpolation works for me and it is simple. No big deal though, not worth discussing it.

senny · 2014-05-22T14:37:06Z

@dhh uncommented the sections you proposed and added gem install bundler --conservative to make sure bundler is available.

arthurnn · 2014-05-22T15:43:46Z

railties/lib/rails/generators/rails/app/templates/bin/setup

why do we wanna include this? at least the apps I worked with 10% of them needed to copy a database.yml.sample , wondering if adding this will make starters life harder?

It's commented out as a suggestion. We have some projects where this is needed.

Actually, I’d kill this. We have the secrets.yml now. So everyone is supposed to checkin database.yml.

On May 22, 2014, at 5:45 PM, Yves Senn notifications@github.com wrote:

In railties/lib/rails/generators/rails/app/templates/bin/setup:

+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', FILE)
+
+Dir.chdir APP_ROOT do

This script is a starting point to setup your application.

Add necessary setup steps to this file:

puts "== Installing dependencies =="

system "gem install bundler --conservative"

system "bundle install"

puts "\n== Copying sample files =="

unless File.exists?("config/database.yml")

system "cp config/database.yml.sample config/database.yml"

end

It's commented out as a suggestion. We have some projects where this is needed.

—
Reply to this email directly or view it on GitHub.

Copying sample files is not directly related to database.yml. I could change the file name.

We could change this to copy a sample of secrets.yml instead.

I’d like to see a realistic example before we include it.

On May 22, 2014, at 6:00 PM, Lucas Mazza notifications@github.com wrote:

In railties/lib/rails/generators/rails/app/templates/bin/setup:

+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', FILE)
+
+Dir.chdir APP_ROOT do

This script is a starting point to setup your application.

Add necessary setup steps to this file:

puts "== Installing dependencies =="

system "gem install bundler --conservative"

system "bundle install"

puts "\n== Copying sample files =="

unless File.exists?("config/database.yml")

system "cp config/database.yml.sample config/database.yml"

end

We could change this to copy a sample of secrets.yml instead.

—
Reply to this email directly or view it on GitHub.

secrets.yml can be checked too. We use sample files a lot but I'd remove it since I believe it is specific of some projects.

fxn · 2014-05-22T16:35:29Z

Regarding docs:

The Getting Started guide has a table that explains the project layout. The description about bin could mention this script.

Also implicitly, if the guide had bin/setup as one of its steps that would communicate that's a blessed step. But for that to happen the generated bin/setup would probably need to do something meaningful in newly generated apps, otherwise I don't see it.

fxn · 2014-05-22T16:38:07Z

Oh, and if it did something meaningful in newly generated apps and mentioned as is in the getting started guide, then I believe the generated bin/setup should for the same price be portable, using FileUtils rather than shelling out.

senny · 2014-05-29T11:33:45Z

/cc @zzak @chancancode should I add this to the release notes?

zzak · 2014-05-29T16:53:59Z

@senny I think so

chancancode · 2014-05-29T19:09:11Z

@senny it's still sitting on a branch, and we haven't started writing about railties yet, so it's up to you :) If you don't, I'll make sure I add it when we do the initial pass on railties.

chancancode · 2014-05-29T19:10:09Z

(branch: https://github.com/rails/rails/tree/4-2-release_notes)

senny · 2014-05-30T09:35:28Z

Updated according to suggestions. Going to merge this so other can contribute as well.

`bin/setup` script to bootstrap applications.

pftg · 2014-05-30T12:30:27Z

👍

DamirSvrtan · 2015-07-15T00:08:16Z

The way bin/setup is now written, it creates a fresh start - at least for the database. If you pull new changes to a project you're already working on - you'll have your database droped, recreated and migrated all over again. You'll lose all development data.

Wouldn't it be convenient to have the bin/setup just migrate your database if it already exists?
I would love a second opinion on this.

I'm currently using the following code snippet although i guess there should be a better way to check if the database exists:

system <<-SHELL
  bin/rake db:migrate:status > /dev/null
  if [ "$?" = "0" ]; then
    echo "\n== Migrating database =="
    bin/rake db:migrate
  else
    echo "\n== Preparing database =="
    bin/rake db:setup
  fi
SHELL

pftg · 2015-07-15T10:11:02Z

bin/setup should be changed by developers per each project and should not be swiss knife.
I think about bin/setup as example where you should put your setup code, but not as final solution.

Some guys expected to run this once after git clone to do clean setup, some other expected to re-run on each git pull and update only missed parts.

P.S. there is a google group where you can discuss such ideas or propositions

dhh · 2015-07-15T11:06:36Z

If you already have the database setup, then you already have the app
running, then bin/setup is not intended for you. We have rake db:migrate
and bundle to deal with those. I think bin/setup as "clean slate" is what
we're trying to achieve with this.

On Wed, Jul 15, 2015 at 2:09 AM, DamirSvrtan notifications@github.com
wrote:

The way bin/setup is now written, it creates a fresh start - at least for
the database. If you pull new changes to a project you're already working
on - you'll have your database droped, recreated and migrated all over
again. You'll lose all development data.

Wouldn't it be convenient to have the bin/setup just migrate your
database if it already exists? I would love a second opinion on this.

I'm currently using the following code snippet although i guess there
should be a better way to check if the database exists:

system <<-SHELL bin/rake db:migrate:status > /dev/null if [ "$?" = "0" ]; then echo "\n== Migrating database ==" bin/rake db:migrate else echo "\n== Preparing database ==" bin/rake db:setup fiSHELL

—
Reply to this email directly or view it on GitHub
#15189 (comment).

DamirSvrtan · 2015-07-15T12:31:56Z

Thank you David - I was looking for an explanation on this part - wether it should be used for a clean state setup or a continuos setup. We have devs that only do frontend/javascript work on our applications and know very little about Rails - that's why I was looking at ./bin/setup and rails s to be the only commands they need to know to get up and going with their work.

fxn · 2015-07-15T12:48:31Z

@DamirSvrtan maybe a custom bin/update ad-hoc for your project could fit your workflow. That is, you throw your own thing custom-made for your team, and then document that's the way frontend people update the project.

dhh · 2015-07-15T12:57:38Z

I think that's a great idea, Xavier. That's how bin/setup started out for
us too.

On Wed, Jul 15, 2015 at 2:49 PM, Xavier Noria notifications@github.com
wrote:

@DamirSvrtan https://github.com/DamirSvrtan maybe a custom bin/update
ad-hoc for your project could fit your workflow. That is, you throw your
own thing custom-made for your team, and then document that's the way
frontend people update the project.

—
Reply to this email directly or view it on GitHub
#15189 (comment).

* Adds a new file bin/setup which is intended to act as a bootstrapper: rails/rails#15189 I'm not sure the default ('starting point') script is helpful here

squash! Generated template changes in Rails 4.2 * Adds assets.digest = true to develop * Adds a new file bin/setup which is intended to act as a bootstrapper: rails/rails#15189 * Adds a new initializer that allows us to tell ActiveSupport to preserve timezones when using Ruby 2.4

* Adds assets.digest = true to develop * Adds a new file bin/setup which is intended to act as a bootstrapper: rails/rails#15189 * Adds a new initializer that allows us to tell ActiveSupport to preserve timezones when using Ruby 2.4

senny added the railties label May 20, 2014

dhh reviewed May 22, 2014
View reviewed changes

railties/lib/rails/generators/rails/app/templates/bin/setup

Copy link

Member

dhh May 22, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before even this, we should install bundler.

arthurnn reviewed May 22, 2014
View reviewed changes

bin/setup script to bootstrap applications.

7ba6b75

senny changed the title ~~bin/setup script to bootstrap applications. [WIP]~~ bin/setup script to bootstrap applications. May 30, 2014

senny added a commit that referenced this pull request May 30, 2014

Merge pull request #15189 from senny/bin/setup

58d3e02

`bin/setup` script to bootstrap applications.

senny merged commit 58d3e02 into rails:master May 30, 2014

senny deleted the bin/setup branch May 30, 2014 09:35

ghost mentioned this pull request Oct 7, 2014

use bin/setup instead bin/bootstrap fs/rails-base#224

Closed

monfresh mentioned this pull request Mar 15, 2015

Revamp Rails howto to cover local setup rather than starting a new project codeforamerica/howto#27

Closed

rsanheim mentioned this pull request Jul 18, 2015

add system! to fail fast in bin/setup #20926

Merged

JuanitoFatas mentioned this pull request Jan 11, 2016

Make setup for project easier with bin/setup script rubycentral/cfp-app#78

Merged

mauro-oto referenced this pull request in ombulabs/blog Jun 29, 2016

Added an article about bin/start

13713ad

kkelleey mentioned this pull request Jul 28, 2016

New setup script ifmeorg/ifme#247

Closed

aried3r mentioned this pull request Apr 28, 2017

Getting started: rake db:migrate gothinkster/rails-realworld-example-app#2

Merged

bin/setup script to bootstrap applications. #15189

bin/setup script to bootstrap applications. #15189

Uh oh!

Conversation

senny commented May 20, 2014

About

Example

Work

Uh oh!

pftg commented May 20, 2014

Uh oh!

sgrif commented May 20, 2014

Uh oh!

rafaelfranca commented May 20, 2014

Uh oh!

senny commented May 20, 2014

Uh oh!

rafaelfranca commented May 20, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dhh commented May 22, 2014

Uh oh!

dhh commented May 22, 2014

Uh oh!

senny commented May 22, 2014

Uh oh!

fxn commented May 22, 2014

Uh oh!

fxn commented May 22, 2014

Uh oh!

senny commented May 22, 2014

Uh oh!

fxn commented May 22, 2014

Uh oh!

senny commented May 22, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

This script is a starting point to setup your application.

Add necessary setup steps to this file:

puts "\n== Copying sample files =="

unless File.exists?("config/database.yml")

system "cp config/database.yml.sample config/database.yml"

end

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

This script is a starting point to setup your application.

Add necessary setup steps to this file:

puts "\n== Copying sample files =="

unless File.exists?("config/database.yml")

system "cp config/database.yml.sample config/database.yml"

end

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fxn commented May 22, 2014

Uh oh!

fxn commented May 22, 2014

Uh oh!

senny commented May 29, 2014

Uh oh!

zzak commented May 29, 2014

Uh oh!

chancancode commented May 29, 2014

Uh oh!

chancancode commented May 29, 2014

Uh oh!

senny commented May 30, 2014

Uh oh!

pftg commented May 30, 2014

Uh oh!

DamirSvrtan commented Jul 15, 2015

`bin/setup` script to bootstrap applications. #15189

`bin/setup` script to bootstrap applications. #15189