Adding warning for upcoming major version upgrade #325
Conversation
Signed-off-by: Vacha Shah <[email protected]>
| @@ -10,6 +10,10 @@ OpenSearch Go Client | |||
| - [License](#license) | |||
| - [Copyright](#copyright) | |||
|
|
|||
| > **Warning** | |||
| > | |||
| > `2.3.0` is the last minor version for the 2.x line for the OpenSearch Go client. All new features will now be added to the upcoming major version 3.0.0 being developed in the [`main`](https://github.com/opensearch-project/opensearch-go) branch of this client. To upgrade to the next major version,see [UPGRADING](https://github.com/opensearch-project/opensearch-go/blob/main/UPGRADING.md). The 2.3.x line will be managed and supported for security fixes. | |||
There was a problem hiding this comment.
I am not convinced me need this. At the time of writing this the latest version is 2.3.x, and when we release 3.0 the latest version will be 3.0. All major upgrades carry breaking changes.
So what is this warning me about and what would I do differently after reading this?
If we want to say what one should use, we could add a "Stable Release" section such as https://github.com/ruby-grape/grape/#stable-release.
There was a problem hiding this comment.
Makes sense. I added this section after the comment - that we would move to 3.x line. So this was to inform the users that 2.3.x would be the last in line for 2.x and there won't be a 2.4.0 coming with new features. For new features, it would be 3.0.0. I think this is not needed anymore. Sorry for the confusion!
Description
Coming from #322 (comment), adding a warning for 2.3.0 being the last version of the 2.x line and moving to 3.0.0.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.