Skip to content

Commit 5031882

Browse files
committed
Update README
Add notes about versions.
1 parent 7783c1b commit 5031882

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
[![Gem Version](https://img.shields.io/gem/v/ruby_dep.svg?style=flat)](https://rubygems.org/gems/ruby_dep) [![Build Status](https://travis-ci.org/e2/ruby_dep.svg)](https://travis-ci.org/e2/ruby_dep)
44

5+
NOTE: For currently supported Ruby versions, [check out the Travis build status](https://travis-ci.org/e2/ruby_dep). If you need support for an different/older version of Ruby, open an issue with "backport" in the title and provide a compelling case for supporting the version of Ruby you need. When in doubt, open a new issue.
6+
7+
58
## The problem
69

710
Your gem shouldn't (and likely doesn't) support all possible Ruby versions.
@@ -76,13 +79,13 @@ To disable warnings, just set the following environment variable:
7679

7780
`RUBY_DEP_GEM_SILENCE_WARNINGS=1`
7881

79-
You can follow these rules of thumb:
82+
You can follow these rules of thumb, whether you use RubyDep or not:
8083

8184
1. Avoid changing major version numbers, even if you're dropping a major version of Ruby (e.g. 1.9.2)
82-
2. If you want to support a current version, add it to your `.travis.yml` (e.g. Ruby 2.3.1)
85+
2. If you want to support a current version, add it to your `.travis.yml` (e.g. ruby-2.3.1)
8386
3. To support an earlier version of Ruby, add it to your `.travis.yml` and release a new gem version.
84-
4. If you want to support a range of Rubies, include the whole range without gaps in minor version numbers (e.g. 2.0.0, 2.1.0, 2.2.0, 2.3.0)
85-
5. If you just want to test a Ruby version (but not actually support it), put it into the "allow failures" part of your Travis build matrix.
87+
4. If you want to support a range of Rubies, include the whole range without gaps in minor version numbers (e.g. 2.0.0, 2.1.0, 2.2.0, 2.3.0) and ruby_dep will use the whole range. (If there's a gap, older versions will be considered "unsupported")
88+
5. If you just want to test a Ruby version (but not actually support it), put it into the "allow failures" part of your Travis build matrix. (ruby_dep ignores versions there).
8689
6. If you want to drop support for a Ruby, remove it from the `.travis.yml` and just bump your gem's minor number.
8790

8891
When in doubt, open an issue and just ask.

0 commit comments

Comments
 (0)