[FEATURE] Release 3.0

[dblock]

Is your feature request related to a problem?

We have some awesome (and breaking) changes in 3.0 that help developers write better code, e.g. #246 (comment).

What solution would you like?

Release 3.0!

[wbeckler]

There's a possible issue coming down the pipe that might be breaking. It would be nice to pile all the breaking stuff into one release so we don't need to go to 4.0.

[Jakob3xD]

@dblock Imo we could do a release once the two open PRs get merged.
I don´t think that we will have the plugins like security and ism ready withing the next few weeks and as they should only extend and not brake anything, I see no point in holding back a release.

[dblock]

💯

[dblock]

@Jakob3xD I think we're good to go, are we? Want to make a release?

[Jakob3xD]

@Jakob3xD I think we're good to go, are we? Want to make a release?

What is the exact process to do a new release?
Do I make a PR where I bump the version in internal/version/version.go to 3.0.0 and change the CHANGELOG.md from ## [Unreleased] to ## [v3.0.0], then merge it into main? Or don´t we keep a history of CHANGELOG and only list unreleased changes? Afterwards create branches named 3.x and 3.0. So that I create a tag named v3.0.0 out of branch 3.0.

[dblock]

@Xtansia Did you do the last one?

I believe yes, 1) you make changes on main for the version and CHANGELOG, then make a tag and the rest is automated, 2) increment version to 3.0.1 and PR/commit that.

I don't think we need a 3.x or a 3.0 branch, we can continue releasing off main. Those are only needed if we want to continue releasing 2.x versions for example, which I'd rather not.

Will you help us with documenting this as you go in https://github.com/opensearch-project/opensearch-go/blob/main/RELEASING.md, please?

[Xtansia]

I didn't do the last release, Vacha did, I don't have maintainer permissions on this client.

The version bump PR from then shows a couple places to change the version: 288e46e

[Jakob3xD]

I created the Tag and mad a release https://github.com/opensearch-project/opensearch-go/releases/tag/v3.0.0 I hope this is okay? Please edit if something is wrong.

[dblock]

Looking at https://pkg.go.dev/github.com/opensearch-project/opensearch-go/ I don't see a release. I have no idea what the "right way" is, @VachaShah could you help make a release and help us make sure that's automated and documented correctly this time around?

[Jakob3xD]

I repushed the v3.0.0 tag with the module change to v3. At lease downloading the lib works now.

go get github.com/opensearch-project/opensearch-go/v3

[Jakob3xD]

It is now present https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3

[dblock]

Amazing. I upgraded my little demo project in dblock/opensearch-go-client-demo@bad06d1. Do PR any improvements to the code ;)

[dblock]

Reopening this since we still need to bump the version to 3.0.1. @Jakob3xD

How does the magic of publishing a release for the go client happen? Is it something we registered once on pkg.go.dev and it just auto-publishes all releases from GitHub? @VachaShah

[VachaShah]

Apologies for being late on this! I was out on vacation. For golang packages, pushing a tag to the repo makes them available to use. https://go.dev/doc/modules/publishing

[Jakob3xD]

Reopening this since we still need to bump the version to 3.0.1. @Jakob3xD

Why do we need this? What change is happening with the release?

[dblock]

@Jakob3xD I suggest we bump the version for the next developer iteration, so that we don't have code that still says 3.0 while it already has changes on top of that (it's no longer 3.0). We also need to update CHANGELOG to Unreleased. I did this in #448, take a look?