diff options
author | The Bundler Bot <bot@bundler.io> | 2018-02-13 01:45:35 +0000 |
---|---|---|
committer | The Bundler Bot <bot@bundler.io> | 2018-02-13 01:45:35 +0000 |
commit | 30f7b45e2414eb82e1dcc592a4dd5146438f4a63 (patch) | |
tree | 775a228993b406fe97b6ec737f2184b54c488982 /man | |
parent | 79d6e4f6c55704b7c715fc99a102048a6d030545 (diff) | |
parent | da6e69224705406698d01cff54bdd9ca18278a4c (diff) | |
download | bundler-30f7b45e2414eb82e1dcc592a4dd5146438f4a63.tar.gz |
Auto merge of #6184 - arbonap:pa-check-in-gemfile-docs, r=indirect
Update docs to reflect revised guidance to check in locks for gems
Thanks so much for the contribution!
To make reviewing this PR a bit easier, please fill out answers to the following questions.
### What was the end-user problem that led to this PR?
The problem was...
- Bundler stopped gitignoring gem locks. The change was merged in but we need to reflect that change in documentation.
### What was your diagnosis of the problem?
My diagnosis was...
- To add in documentation explaining why Bunder now does _not_ gitignore gem locks.
### What is your fix for the problem, implemented in this PR?
My fix...
- Update the `gemfile.lock` section of `bundle install` man pages as well as the `gemfile` man page.
### Why did you choose this fix out of the possible options?
I chose this fix because...
- This addresses open issue https://github.com/bundler/bundler/issues/5879
Diffstat (limited to 'man')
-rw-r--r-- | man/bundle-install.ronn | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn index 59e5adcd58..a4034bc506 100644 --- a/man/bundle-install.ronn +++ b/man/bundle-install.ronn @@ -295,12 +295,21 @@ of a dependency of a gem in your Gemfile(5)) can result in radically different gems being needed to satisfy all dependencies. As a result, you `SHOULD` check your `Gemfile.lock` into version -control. If you do not, every machine that checks out your -repository (including your production server) will resolve all +control, in both applications and gems. If you do not, every machine that +checks out your repository (including your production server) will resolve all dependencies again, which will result in different versions of third-party code being used if `any` of the gems in the Gemfile(5) or any of their dependencies have been updated. +When Bundler first shipped, the `Gemfile.lock` was included in the `.gitignore` +file included with generated gems. Over time, however, it became clear that +this practice forces the pain of broken dependencies onto new contributors, +while leaving existing contributors potentially unaware of the problem. Since +`bundle install` is usually the first step towards a contribution, the pain of +broken dependencies would discourage new contributors from contributing. As a +result, we have revised our guidance for gem authors to now recommend checking +in the lock for gems. + ## CONSERVATIVE UPDATING When you make a change to the Gemfile(5) and then run `bundle install`, |