opensearch-js icon indicating copy to clipboard operation
opensearch-js copied to clipboard

[FEATURE] Release v. Next

Open dblock opened this issue 3 years ago • 6 comments

Is your feature request related to a problem?

Coming from https://github.com/opensearch-project/opensearch-js/issues/187#issuecomment-1260735471.

What solution would you like?

Release v. Next.

Do you have any additional context?

Please add your +1 if you need a release.

dblock avatar Sep 29 '22 17:09 dblock

I see the documentation has been updated with examples containing functionality that wasn't released yet (namely the AWS Sigv4 signer) - I'd have thought that everything that's on "main" is released. Would it make more sense to use a different branching strategy to avoid such issues in the future?

dragosmc avatar Sep 29 '22 17:09 dragosmc

@dragosmc Example? Link? That's really an issue for the documentation, you should open one saying something was documented that wasn't released. I'd expect extreme clarity on http://opensearch.org/ about what version's documentation one is reading.

dblock avatar Sep 29 '22 17:09 dblock

I don't know if it's visible on the opensearch.org website, but I came here looking for how to do sigv4 and stumbled across this page https://github.com/opensearch-project/opensearch-js/blob/main/USER_GUIDE.md#using-aws-v2-sdk that's referenced from the readme on "main" branch.

dragosmc avatar Sep 29 '22 17:09 dragosmc

I don't know if it's visible on the opensearch.org website, but I came here looking for how to do sigv4 and stumbled across this page https://github.com/opensearch-project/opensearch-js/blob/main/USER_GUIDE.md#using-aws-v2-sdk that's referenced from the readme on "main" branch.

That's expected, the documentation on main is for main. We could put something like https://github.com/ruby-grape/grape#stable-release in that doc, feel free to add that!

dblock avatar Sep 29 '22 17:09 dblock

Looks like we have consensus to release 2.1.0 with Sigv4 support. Adding a release checklist and linking infra issue.

All CI pass

  • [ ] OpenSearch 2.0 is fully supported
  • [ ] OpenSearch 1.x is fully supported

Release Process

https://github.com/opensearch-project/opensearch-js/blob/main/RELEASING.md

  • [X] ~~Cut release to infra team~~ Opened https://github.com/opensearch-project/opensearch-build/issues/2690
  • [ ] Release branch created for 2.1 release
  • [ ] Tag created for 2.1 release
  • [ ] Release branch created for the next 2.x release

Post release

  • [ ] Update release with release notes
  • [ ] Bump version to 2.1.1 -- necessary until #293

harshavamsi avatar Oct 04 '22 19:10 harshavamsi

@nhtruong Have the above steps been taken and can we close this?

wbeckler avatar Nov 16 '22 15:11 wbeckler