Fix #37: Lock Listen to less than 3.1. #38
Conversation
Jekyll supports 2.1+ but @e2 has made it so that Listen only supports 2.2 so this locks it so that we are on a version of Listen that we can actually support since we still support all supporte Ruby versions.
| @@ -13,7 +13,7 @@ Gem::Specification.new do |spec| | |||
| spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } | |||
| spec.require_paths = ["lib"] | |||
|
|
|||
| spec.add_runtime_dependency "listen", "~> 3.0" | |||
| spec.add_runtime_dependency "listen", "~> 3.0", "< 3.1" | |||
There was a problem hiding this comment.
Hm, I'm afraid we'll never remember to remove this constraint. Should we add a comment describing when it can be released, like # Remove < 3.1 constraint when we drop support for Ruby 2.0?
There was a problem hiding this comment.
I actually thought about that! How about: "XXX: Remove with Jekyll 4 or in 2017 when 2.1 goes EOL"?
|
👍 Thanks! @jekyllbot: merge +bug |
|
Guys, this is a bit dangerous (locking): If you stick to Listen 3.0.x, and someone accepts a Ruby 2.2.x-only patch into a 3.0.x version of Listen (there are no safety checks for this ATM!), things will break for your users in PRODUCTION! (If they upgrade with the lock in place). If there's any line of code which is Ruby 2.2.x specific that doesn't have coverage (or has a different behavior), users with Ruby 2.1 using Listen 3.0.x (with a backported patch like that) will experience a crash. This is unlikely, but technically, that's what's going on. Not to mention: everyone locked to 3.0.x is now stuck without having any new patches or updates. (Unless backported). The best solution is to release a version of jekyll-watch that is Ruby '~> 2.2' only. That's because users with Ruby 2.2 should have a choice of using Listen 3.1.x. By locking, you've taken that choice away. (Ironically, Ruby 2.2. users would have to lock to an earlier version of jekyll-watch - just in order to upgrade past Listen >= 3.1 for bugfixes). Summary: By locking, you're doing 2 "bad" things:
Moral: all because it looks like it works, doesn't mean it's supposed to. |
Jekyll supports 2.1+ but @e2 has made it so that Listen only supports
2.2 so this locks it so that we are on a version of Listen that we can
actually support since we still support all supporte Ruby versions.