Skip to content

Commit c99dec5

Browse files
committed
[DOCS] Updates docs on compatibility
1 parent 8d98042 commit c99dec5

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

README.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,23 @@ see the **[elasticsearch-rails](https://github.com/elasticsearch/elasticsearch-r
5353

5454
## Compatibility
5555

56-
The Elasticsearch client is compatible with currently maintained Ruby versions. See [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). We don't provide support to versions which have reached their end of life.
56+
We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
57+
58+
Elastic language clients are guaranteed to be able to communicate with Elasticsearch or Elastic solutions running on the same major version and greater or equal minor version.
59+
60+
Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are not guaranteed to be backwards compatible.
5761

5862
The gem's version numbers follow Elasticsearch's major versions. The `master` branch is compatible with the Elasticsearch `master` branch, which is the next major version.
5963

60-
| Gem Version | | Elasticsearch |
61-
|:-------------:|:-:| :-----------: |
62-
| 0.90 || 0.90 |
63-
| 1.x || 1.x |
64-
| 2.x || 2.x |
65-
| 5.x || 5.x |
66-
| 6.x || 6.x |
67-
| 7.x || 7.x |
68-
| master || master |
64+
| Client version | Elasticsearch version | Supported | Tests |
65+
| :-------------: | :-------------------: | :-: | :---: |
66+
| 0.90 | 0.90 | :x: | |
67+
| 1.x | 1.x | :x: | |
68+
| 2.x | 2.x | :x: | |
69+
| 5.x | 5.x | :x: | |
70+
| 6.x | 6.x | :white_check_mark: | [![6.x](https://github.com/elastic/elasticsearch-ruby/actions/workflows/6.x.yml/badge.svg?branch=6.x)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/6.x.yml)|
71+
| 7.x | 7.x | :white_check_mark: | [![7.x](https://github.com/elastic/elasticsearch-ruby/actions/workflows/7.x.yml/badge.svg?branch=7.x)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/7.x.yml) |
72+
| master | master | :x: | [![master](https://github.com/elastic/elasticsearch-ruby/actions/workflows/master.yml/badge.svg?branch=master)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/master.yml) |
6973

7074
## Installation
7175

docs/installation.asciidoc

+4-3
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@ gem 'elasticsearch', '~> 7.0'
3838
[discrete]
3939
=== {es} and Ruby Version Compatibility
4040

41-
The {es} client is compatible with Ruby 1.9 and higher.
41+
The {es} client is compatible with currently maintained Ruby versions. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per https://www.ruby-lang.org/en/downloads/branches/[Ruby Maintenance Branches].
4242

43-
The client's API is compatible with {es} API versions from 0.90 till current,
44-
just use a release matching major version of {es}.
43+
Elastic language clients are guaranteed to be able to communicate with Elasticsearch or Elastic solutions running on the same major version and greater or equal minor version.
44+
45+
Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are not guaranteed to be backwards compatible.
4546

4647
|===
4748
| Gem Version | | {es} Version

0 commit comments

Comments
 (0)