opensearch-project / opensearch-project/opensearch-ruby

[RELEASE] Alignment with OpenSearch 3.0.0 GA

Open
#294 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
114
Forks
60
PR merge metrics
No merged PRs in 30d

Description

Context

The OpenSearch 3.0.0 GA release is currently scheduled for 2025/05/06: https://github.com/opensearch-project/opensearch-build/issues/3747
As such there will be desire for the clients to provide support for the 3.0.0 release.

Tasks

  • 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
    • 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
  • 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the integration test workflow matrices and the existing COMPATABILITY.md file, then review the linked specification changes. Determine whether code generation is used and whether the OpenSearch 3.0.0 changes are breaking or non-breaking. Done means the applicable checklist items are completed, including compatibility updates and the appropriate client release work.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.