Bumped Version 3.0.0 (#180)

Signed-off-by: Theo Truong <[email protected]>

Author: nhtruong

CHANGELOG.md

@@ -1,8 +1,15 @@
 # CHANGELOG
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-
 ## [Unreleased]
 ### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+## [3.0.0]
+### Added
 - Added `remote_store.restore` action ([#176](https://github.com/opensearch-project/opensearch-ruby/pull/176))
 - Added API Generator ([#139](https://github.com/opensearch-project/opensearch-ruby/issues/139))
 - Added Security API through API Generator ([#179](https://github.com/opensearch-project/opensearch-ruby/pull/179))

COMPATIBILITY.md

@@ -1,27 +1,11 @@
-- [Compatibility with OpenSearch](#compatibility-with-opensearch)
-- [Upgrading](#upgrading)
+# Compatibility with OpenSearch
 
-## Compatibility with OpenSearch
+The below matrix shows the compatibility of the [`opensearch-ruby`](https://rubygems.org/gems/opensearch-ruby) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch). In the vast majority of cases, a minor version upgrade of the OpenSearch cluster does not affect how your application's existing features interact with the cluster via the Ruby client. However, such an upgrade can introduce new endpoints that your current version of the client does not support. In this case, you must upgrade the client to the version shown in the table below (or higher) to use the new endpoints.
 
-The below matrix shows the compatibility of the [`opensearch-ruby`](https://rubygems.org/gems/opensearch-ruby) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch).
+If your Server Version is higher than those listed in the table below, you should use the newest client. If the newest client still does not support the endpoint you need, please open an issue and let us know.
 
-| OpenSearch Version | Client Version |
-| --- | --- |
-| 1.0.0 | 1.0.0 |
-| 1.0.1 | 1.0.0 |
-| 1.1.0 | 1.0.0 |
-| 1.2.0 | 1.0.0 |
-| 1.2.1 | 1.0.0 |
-| 1.2.2 | 1.0.0 |
-| 1.2.3 | 1.0.0 |
-| 1.2.4 | 1.0.0 |
-| 1.3.0 | 1.0.0 |
-| 1.3.1 | 1.0.0 |
-| 1.3.2 | 1.0.0 |
-| 1.3.3 | 1.0.0 |
-| 2.0.0 | 2.0.2 |
-| 2.0.1 | 2.0.2 |
-
-## Upgrading
-
-Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-ruby-client` 2.0.2 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information.
+| Server Version | Client Version |
+|----------------|----------------|
+| 1.x            | 1.0            |
+| 2.4            | 2.2            |
+| 2.x            | 3.0            |

README.md

@@ -94,6 +94,10 @@ See [USER_GUIDE](USER_GUIDE.md).
 
 See [Compatibility](COMPATIBILITY.md).
 
+## Upgrading
+
+See [UPGRADING](UPGRADING.md).
+
 ## Developer Guide
 
 See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).

UPGRADING.md

@@ -0,0 +1,12 @@
+# Upgrading
+Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. Check the [Compatibility](COMPATIBILITY.md) doc to see which version of the client should be used against your OpenSearch cluster.
+
+### Upgrade to OpenSearch Ruby 3
+In Version 3 of the OpenSearch Ruby client, we have added the `api` and `transport` modules as the core components of the gem, instead of treating them as separate gems that are required by the `opensearch-ruby` gem. This removes the confusions around compatibility between the ruby client, its legacy dependencies, and the OpenSearch cluster.
+
+`opensearch-dsl` has also been moved into `opensearch-ruby` 3.0. If your application uses `opensearch-dsl`, you should now remove this gem from your Gemfile or gemspec.
+
+We don't expect the upgrade to OpenSearch Ruby 3 to be a breaking change for the vast majority of use cases, and you do not have to make any changes to your application before the upgrade. On your development environment, you might want to perform a `bundle clean` to remove `opensearch-api`, `opensearch-transport`, and `opensearch-dsl` gems after the upgrade.
+
+### Upgrade to OpenSearch Ruby 2
+While `opensearch-ruby-client` 2.x works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. So, only upgrade to `opensearch-ruby` gem to 2.x if you are also upgrading your cluster to OpenSearch 2.0.

lib/opensearch/version.rb

@@ -25,5 +25,5 @@
 # under the License.
 
 module OpenSearch
-  VERSION = '2.2.0'.freeze
+  VERSION = '3.0.0'.freeze
 end