Skip to content

[PROPOSAL] Combine gems, extract opensearch-aws-sigv4 #133

@dblock

Description

@dblock

What/Why

What are you proposing?

There are 5 gems in this repo:

  • opensearch-api
  • opensearch-dsl
  • opensearch-ruby
  • opensearch-aws-sigv4
  • opensearch-transport

All except opensearch-aws-sigv4 are always used by anyone wanting to call OpenSearch in Ruby.

  • Propose to merge them into opensearch-ruby.
  • Propose to extract opensearch-aws-sigv4 into a separate repo.

What users have asked for this feature?

Coming from #127.

What problems are you trying to solve?

  • I don't believe anyone ever uses opensearch-api, opensearch-dsl, opensearch-transport separately from opensearch-ruby. Seems like unnecessary overhead.
  • We have tags such as opensearch-api/2.1.2 and the number of tags will grow fast. Each tag only refers to a subset of the code, and may incorrectly imply some relationship between, say opensearch-ruby and opensearch-api in the tag. Theoretically they could even be incompatible.
  • Our 1.x, 2.x branching strategy forces to release all the gems at the same time or create more confusion.

What is the developer experience going to be?

Major increment opensearch-ruby and collapse the other 3 gems into it.

Extract code for opensearch-aws-sigv4 into a new repo called opensearch-ruby-aws-sigv4.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions