From 424c14153981162cffb5b8b82544799a36c53575 Mon Sep 17 00:00:00 2001 From: Michael Kohl Date: Thu, 6 Feb 2020 05:01:04 +0700 Subject: [PATCH] Remove Foreman gem (#5821) --- Gemfile | 2 -- Gemfile.lock | 9 --------- docs/getting-started/start-app.md | 3 ++- docs/installation/others.md | 23 +++++++++++++++++++++++ docs/installation/readme.md | 1 + 5 files changed, 26 insertions(+), 12 deletions(-) create mode 100644 docs/installation/others.md diff --git a/Gemfile b/Gemfile index 4efa8087d..96baa258e 100644 --- a/Gemfile +++ b/Gemfile @@ -112,8 +112,6 @@ group :development do gem "derailed_benchmarks", "~> 1.6", require: false # A series of things you can use to benchmark a Rails or Ruby app gem "erb_lint", "~> 0.0", require: false # ERB Linter tool gem "fix-db-schema-conflicts", "~> 3.0" # Ensures consistent output of db/schema.rb despite local differences in the database - # switch foreman to stable release when thor dependency is updated to 0.20+ - gem "foreman", github: "thepracticaldev/foreman", ref: "b64e401", require: false # Process manager for applications with multiple components gem "guard", "~> 2.16", require: false # Guard is a command line tool to easily handle events on file system modifications gem "guard-livereload", "~> 2.5", require: false # Guard::LiveReload automatically reloads your browser when 'view' files are modified gem "guard-rspec", "~> 4.7", require: false # Guard::RSpec automatically run your specs diff --git a/Gemfile.lock b/Gemfile.lock index 4585d7918..0c05f24a4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -6,14 +6,6 @@ GIT acts_as_follower (0.2.1) activerecord (>= 4.0) -GIT - remote: https://github.com/thepracticaldev/foreman.git - revision: b64e4019a8ed3cfae7216c3219dc91833845d9c7 - ref: b64e401 - specs: - foreman (0.85.0) - thor (>= 0.19, < 0.21) - GEM remote: https://rubygems.org/ specs: @@ -927,7 +919,6 @@ DEPENDENCIES figaro (~> 1.1) fix-db-schema-conflicts (~> 3.0) fog-aws (~> 3.5) - foreman! front_matter_parser (~> 0.2) gemoji (~> 3.0.1) gibbon (~> 3.3) diff --git a/docs/getting-started/start-app.md b/docs/getting-started/start-app.md index 933cf2230..45a0a44be 100644 --- a/docs/getting-started/start-app.md +++ b/docs/getting-started/start-app.md @@ -14,7 +14,8 @@ running: bin/startup ``` -(This just runs `foreman start -f Procfile.dev`) +(This just runs `foreman start -f Procfile.dev`, for notes on how to install +Foreman, please see [Other Tools](../installation/others.md)) Then point your browser to http://localhost:3000/ to view the site. diff --git a/docs/installation/others.md b/docs/installation/others.md new file mode 100644 index 000000000..8aeeda125 --- /dev/null +++ b/docs/installation/others.md @@ -0,0 +1,23 @@ +--- +title: Other Tools +--- + +# Miscellaneous + +## Foreman + +We use [Foreman](https://github.com/ddollar/foreman) to manage our application +through `Procfile` and `Procfile.dev`. As the +[documentation](https://github.com/ddollar/foreman/blob/master/README.md) points +out, + +> Ruby users should take care _not_ to install foreman in their project's +> `Gemfile`. See this +> [wiki article](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman) +> for more details. + +Instead install Foreman globally with the following command: + +```sh +$ gem install foreman +``` diff --git a/docs/installation/readme.md b/docs/installation/readme.md index e58984a53..6a1b7d6e4 100644 --- a/docs/installation/readme.md +++ b/docs/installation/readme.md @@ -6,6 +6,7 @@ items: - docker.md - gitpod.md - postgresql.md + - others.md --- # Installation Guide