This repository has been archived by the owner on Apr 14, 2021. It is now read-only.
Update docs to reflect revised guidance to check in locks for gems #6184
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
segiddins
approved these changes
Nov 23, 2017
man/bundle-install.ronn
Outdated
| 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 gitignored inside gems. |
man/gemfile.5.ronn
Outdated
| @@ -504,3 +504,13 @@ bundler uses the following priority order: | |||
| `rubygems.org` | |||
| 3. The sources specified via global `source` lines, searching each source in | |||
| your `Gemfile` from last added to first added. | |||
|
|
|||
| ## Should I check my `Gemfile.lock` into version control? | |||
There was a problem hiding this comment.
This feels like this is missing a bit of context. We go from talking about the Gemfile.lock in your application to the Gemfile.lock inside a gem which is not imminently obvious.
How about we change the title to something like:
Should I check my
Gemfile.lockinto version control inside my Gem?
?
deivid-rodriguez
approved these changes
Feb 2, 2018
After reviewing, I think the question and answer is a bad fit for the `gemfile` man page. It does seem like a good fit for the FAQ page on the Bundler documentation site, though, and I'll add it over there.
|
@bundlerbot r+ |
|
📌 Commit da6e692 has been approved by |
bundlerbot
added a commit
that referenced
this pull request
Feb 13, 2018
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
|
☀️ Test successful - status-travis |
bbuchalter
pushed a commit
to Shopify/lhm
that referenced
this pull request
Jul 12, 2018
* Do not specify dependencies in Gemfile (this is a gem) * rake was already in gemspec causing bundler to complain * added package_cloud to gemspec * Change `mysql` to `mysql2` because `mysql` is so ancient it won't even compile * Add Gemfile.lock - this is now considered best practice: rubygems/bundler#6184
This was referenced Jul 12, 2018
8 tasks
colby-swandale
pushed a commit
that referenced
this pull request
Oct 5, 2018
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 (cherry picked from commit 30f7b45)
colby-swandale
pushed a commit
that referenced
this pull request
Oct 5, 2018
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 (cherry picked from commit 30f7b45)
colby-swandale
added a commit
that referenced
this pull request
Oct 7, 2018
* 1-16-stable: Version 1.16.6 with changelog fix uninitialized @use_gvp instance var warning no longer test Ruby 1.9.3 against rubygems master Merge #6708 Auto merge of #6697 - walf443:added_changelog_section, r=hsbt Merge #6687 Merge #6686 Auto merge of #6670 - bundler:colby/invite-stephanie-morillo, r=segiddins Auto merge of #6627 - agrim123:agr-fix-add-groups, r=deivid-rodriguez Auto merge of #6612 - hdf1986:readme-bundle-add, r=segiddins Auto merge of #6495 - bundler:segiddins/6491-extra-gem-platform-in-lockfile, r=segiddins Auto merge of #6493 - agrim123:agr-update-bundle-update-docs, r=colby-swandale Auto merge of #6310 - utilum:rescue_unspecified_exception, r=segiddins Auto merge of #6184 - arbonap:pa-check-in-gemfile-docs, r=indirect fix typo
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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...
What was your diagnosis of the problem?
My diagnosis was...
What is your fix for the problem, implemented in this PR?
My fix...
gemfile.locksection ofbundle installman pages as well as thegemfileman page.Why did you choose this fix out of the possible options?
I chose this fix because...