Skip to content

Commit

Permalink
Add a doc for compatibility
Browse files Browse the repository at this point in the history
Follow up #8112 (comment).

This commit adds a doc for compatibility.
  • Loading branch information
koic authored and bbatsov committed Jun 16, 2020
1 parent 8503147 commit c68696e
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
@@ -1,5 +1,6 @@
* xref:index.adoc[Home]
* xref:installation.adoc[Installation]
* xref:compatibility.adoc[Compatibility]
* Usage
** xref:usage/basic_usage.adoc[Basic Usage]
** xref:usage/auto_correct.adoc[Auto-correct]
Expand Down
36 changes: 36 additions & 0 deletions docs/modules/ROOT/pages/compatibility.adoc
@@ -0,0 +1,36 @@
= Compatibility

RuboCop targets Ruby 2.4+.

RuboCop officially supports MRI and JRuby.

- MRI 2.4+
- JRuby 9.2+
The supported JRuby version follows to MRI compatible version.

== Support Matrix

RuboCop has customarily provided support for about one year after EOL of MRI version. The following table is the support matrix.

|===
| Supported target Ruby version | Last supported RuboCop version

| 1.9 | 0.41
| 2.0 | 0.50
| 2.1 | 0.57
| 2.2 | 0.68
| 2.3 | 0.81
| 2.4 | -
| 2.5 | -
| 2.6 | -
| 2.7 | -
|===

One year provides the community with a transition margin. And the final decision to drop support will be made by core maintainers.

NOTE: The compatibility https://docs.rubocop.org/rubocop/configuration.html#setting-the-target-ruby-version[target Ruby version] mentioned here is about analysys, not runtime.

== Forwards Compatibility

Features may be provided for development version of Ruby. These are experimental introductions and may change before the stable version of Ruby will be released.

0 comments on commit c68696e

Please sign in to comment.