Skip to content

Merge gems#175

Merged
nhtruong merged 1 commit intoopensearch-project:mainfrom
nhtruong:merge_gems
Jun 8, 2023
Merged

Merge gems#175
nhtruong merged 1 commit intoopensearch-project:mainfrom
nhtruong:merge_gems

Conversation

@nhtruong
Copy link
Copy Markdown
Collaborator

@nhtruong nhtruong commented Jun 5, 2023

Description

  • Removed sigv4 gem since it's already been moved to https://github.com/opensearch-project/opensearch-ruby-aws-sigv4
  • Merged Lib files of the remaining 4 gems
  • Merged Test and Spec files (With refactoring to the helper modules)
  • Reworked all rake tasks:
    • Redid all Test tasks to fit single-gem-multi-module structure
    • Redid RDOC task to work with 1 gem instead of multiple
    • Removed unused tasks
  • Updated all workflow to work with single-gem structure
  • Added CHANGELOG.md and change_log workflow
  • Fixed all rubocop infractions in ./lib/**/*
  • Updated all docs accordingly
  • Cleaned up and reworked gemspec and gemfile
  • Updated build.sh to work with single-gem structure.
  • Reworked opensearch_ruby_console.

Issues Resolved

Closes #133

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.

@dblock
Copy link
Copy Markdown
Member

dblock commented Jun 6, 2023

This looks good to me!

Copy link
Copy Markdown
Collaborator

@VachaShah VachaShah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! And solves all the problems we have related to tags.

I think we can also mention as a note for the users (in a separate PR) that there are going to be no new versions of the other gems since they are being combined into one. Similar to how we have for dsl-py.

@nhtruong
Copy link
Copy Markdown
Collaborator Author

nhtruong commented Jun 6, 2023

It's basically complete. Just waiting for https://github.com/opensearch-project/opensearch-ruby-aws-sigv4 to go public so the link checker workflow would pass. Will also have a summary of what was done.

- Removed sigv4 gem since it's already been moved to https://github.com/opensearch-project/opensearch-ruby-aws-sigv4
- Merged Lib files of the remaining 4 gems
- Merged Test and Spec files (With refactoring to the helper modules)
- Reworked all rake tasks:
  - Redid all Test tasks to fit single-gem-multi-module structure
  - Redid RDOC task to work with 1 gem instead of multiple
  - Removed unused tasks
- Updated all workflow to work with single-gem structure
- Added CHANGELOG.md and change_log workflow
- Fixed all rubocop infractions in `./lib/**/*`
- Updated all docs accordingly
- Cleaned up and reworked gemspec and gemfile
- Updated `build.sh` to work with single-gem structure.
- Reworked opensearch_ruby_console.

Signed-off-by: Theo Truong <theotr@amazon.com>
@nhtruong nhtruong marked this pull request as ready for review June 8, 2023 00:18
@nhtruong
Copy link
Copy Markdown
Collaborator Author

nhtruong commented Jun 8, 2023

This is ready for review. I've updated the description with all overview of what was done. Basically only one or two files were untouched while the rest were moved or modified 😅. So, take your time.

rake test:api:unit
rake test:transport:unit
rake test:dsl:unit
rake test:client:unit
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can now add rake test:unit.

end

desc 'Run API tests'
task :all do
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally you can do task name: [:prereq1, :prereq2] .

@dblock
Copy link
Copy Markdown
Member

dblock commented Jun 8, 2023

Looks great, merge it!

Copy link
Copy Markdown
Collaborator

@VachaShah VachaShah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@nhtruong nhtruong merged commit cb179a8 into opensearch-project:main Jun 8, 2023
@nhtruong nhtruong deleted the merge_gems branch June 8, 2023 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants