Add 3.x release

[SamuelCox]

Description

Add official support for 3.x

Issues Resolved

Closes #928

• Update integration test workflow matrices to include the released 3.0.0 (should also check 2.x version list is up-to-date)
• Update any integration tests against unreleased branches to include the 3.x branch
• Run the code generator (if any) against the latest specification changes
• If there are any breaking changes:
  • Check for any further low-hanging breaking changes/fixes worth bundling. (e.g. already deprecated workarounds/renames)
  • Document breaking changes in an UPGRADING.md file
  • Determine based on the level of changes if intermediary alpha/beta/RC releases may be required (2 years since a release so possibly yes)
  • Cut a new major version release
  • Create an issue (and/or raise a PR) on the documentation-website repository for updating the related client documentation (will do after pr merges)
• If there are only non-breaking changes:
  • Cut a new minor version release
• Update the COMPATABILITY.md file to include OpenSearch 3.0.0 and any new client versions

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.

[SamuelCox]

@Xtansia I could probably use some guidance on what more to put in upgrading.md, and in general the other parts of the if there are breaking changes area

[SamuelCox]

@Xtansia Have I misunderstood what you mean by Update any integration tests against unreleased branches to include the 3.x branch The 3.x branch doesn't exist on opensearch yet.

opensearch-py and java don't define it https://github.com/opensearch-project/opensearch-py/blob/main/.github/workflows/integration-unreleased.yml
https://github.com/opensearch-project/opensearch-java/blob/main/.github/workflows/test-integration-unreleased.yml

[Xtansia]

@Xtansia Have I misunderstood what you mean by Update any integration tests against unreleased branches to include the 3.x branch The 3.x branch doesn't exist on opensearch yet.

opensearch-py and java don't define it https://github.com/opensearch-project/opensearch-py/blob/main/.github/workflows/integration-unreleased.yml https://github.com/opensearch-project/opensearch-java/blob/main/.github/workflows/test-integration-unreleased.yml

@SamuelCox Yeah no worries, I wrote the comment before the 3.0.0 release and assumed they'd cut a 3.x branch, but instead they are still developing off main

[Xtansia]

@Xtansia I could probably use some guidance on what more to put in upgrading.md, and in general the other parts of the if there are breaking changes area

I've kept UPGRADING.md up-to-date when I've re-generated and introduced breaking changes along the way, so it should already reflect the current state fairly accurately. It's more of it needs to be updated once the code-gen is re-run and if there's any changes then

[SamuelCox]

@Xtansia I could probably use some guidance on what more to put in upgrading.md, and in general the other parts of the if there are breaking changes area

I've kept UPGRADING.md up-to-date when I've re-generated and introduced breaking changes along the way, so it should already reflect the current state fairly accurately. It's more of it needs to be updated once the code-gen is re-run and if there's any changes then

Cool, I ran the code-gen and seemingly nothing has changed

[Xtansia]

@SamuelCox Did you pass the download flag? i.e. ./build.sh codegen --branch main --include-high-level --download

[SamuelCox]

Probably not 😅 will run again

[SamuelCox]

I ran it as specified here https://github.com/opensearch-project/opensearch-net/blob/main/DEVELOPER_GUIDE.md, I'll update the doc to reflect how to properly run it

[SamuelCox]

This is the only non pure addition in the generated api code I could spot, is this technically a breaking change? The enum value itself was removed, it seems breaking to me

[SamuelCox]

Hmm, some odd test failures. 3.6.0 fails because we send the wrong date format in a date range query. Not sure if the strictness changed in 3.6, because those arent the failures we get in other 3.x versions.

The others are this: Failed Tests.Search.Search.SearchApiStoredFieldsTests.ReturnsExpectedResponse [407 ms] Error Message: Tests.Framework.EndpointTests.ResponseAssertionException : Expected response.Hits.First().Fields.ValueOf<Project, int?>(p => p.NumberOfCommits) to be greater than 0, but found <null>. Response Under Test:

Which doesn't make a lot of sense to me, I'll debug it when I have time

[SamuelCox]

Hmm, some odd test failures. 3.6.0 fails because we send the wrong date format in a date range query. Not sure if the strictness changed in 3.6, because those arent the failures we get in other 3.x versions.

The others are this: Failed Tests.Search.Search.SearchApiStoredFieldsTests.ReturnsExpectedResponse [407 ms] Error Message: Tests.Framework.EndpointTests.ResponseAssertionException : Expected response.Hits.First().Fields.ValueOf<Project, int?>(p => p.NumberOfCommits) to be greater than 0, but found <null>. Response Under Test:

Which doesn't make a lot of sense to me, I'll debug it when I have time

These all seem to be weird bugs that have been fixed in later versions or genuine breaking changes? But honestly I'm not super sure

[SamuelCox]

Have figured all these test failures out now just haven't committed yet, will do soon

[SamuelCox]

@Xtansia Think I've finally sorted out all the issues, could you review when you get a chance please?