Auto merge of #4127 - TimMoore:comment-on-git-vs-https-github-urls, r…

…=segiddins

Explain why we don't use HTTPS for github sources

There are frequent pull requests proposing this change, which has already been merged to 2-0-dev.

Hopefully, this will help avoid so much wasted time.

lib/bundler/dsl.rb

@@ -220,6 +220,19 @@ def method_missing(name, *args)
 
     def add_git_sources
       git_source(:github) do |repo_name|
+        # It would be better to use https instead of the git protocol, but this
+        # can break deployment of existing locked bundles when switching between
+        # different versions of Bundler. The change will be made in 2.0, which
+        # does not guarantee compatibility with the 1.x series.
+        #
+        # See https://github.com/bundler/bundler/pull/2569 for discussion
+        #
+        # This can be overridden by adding this code to your Gemfiles:
+        #
+        #   git_source(:github) do |repo_name|
+        #     repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+        #     "https://github.com/#{repo_name}.git"
+        #   end
         repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
         "git://github.com/#{repo_name}.git"
       end