Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding warning for upcoming major version upgrade #325

Closed
wants to merge 1 commit into from
Closed

Adding warning for upcoming major version upgrade #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!


## Welcome!

**opensearch-go** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of go-elasticsearch licensed under the [Apache v2.0 License](LICENSE.txt). For more information, see [opensearch.org](https://opensearch.org/).
Expand Down