Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding component onboarding README #559

Merged
merged 2 commits into from
Sep 23, 2021
Merged

Conversation

setiah
Copy link
Contributor

@setiah setiah commented Sep 22, 2021

Signed-off-by: Himanshu Setia setiah@amazon.com

Issues Resolved

#558

Check List

  • Commits are signed per the DCO using --signoff

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.

Signed-off-by: Himanshu Setia <setiah@amazon.com>
@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2021

Codecov Report

Merging #559 (96b4ddf) into main (24ebc3e) will increase coverage by 5.48%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #559      +/-   ##
==========================================
+ Coverage   77.48%   82.96%   +5.48%     
==========================================
  Files          59       59              
  Lines        1612     1614       +2     
==========================================
+ Hits         1249     1339      +90     
+ Misses        363      275      -88     
Impacted Files Coverage Δ
bundle-workflow/src/aws/s3_bucket.py 95.23% <0.00%> (-1.43%) ⬇️
bundle-workflow/src/run_integ_test.py 0.00% <0.00%> (ø)
bundle-workflow/src/manifests/test_manifest.py 100.00% <0.00%> (ø)
bundle-workflow/src/manifests/build_manifest.py 100.00% <0.00%> (ø)
...workflow/src/test_workflow/dependency_installer.py 100.00% <0.00%> (ø)
...src/test_workflow/integ_test/local_test_cluster.py 22.33% <0.00%> (+22.33%) ⬆️
...w/src/test_workflow/integ_test/integ_test_suite.py 92.18% <0.00%> (+92.18%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 24ebc3e...96b4ddf. Read the comment docs.

dblock
dblock previously approved these changes Sep 22, 2021
ONBOARDING.md Outdated
1. It supports two test configs - `with-security` and `without-security`, which runs test with security plugin enabled and disabled respectively. Choose one or both depending on what your plugin integration tests support.
2. If your plugin is dependent on `job-scheduler` zip, you can define that in `build-dependencies` in the config. Currently, the test workflow only supports `job-scheduler` as build dependency. Please create an issue if your plugin needs more support.

3. For backward compatibility testing, the `test-workflow` runs backward compatibility tests available in the plugin repository. Like integration test, it has a set of configurable options defined in test_manifest.yml, [example](https://github.com/opensearch-project/opensearch-build/blob/85bbe204e947d5d1579af771bbafe399c11cbd70/bundle-workflow/src/test_workflow/config/test_manifest.yml#L3)
Copy link
Member

Choose a reason for hiding this comment

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

Missing a period :)

@dblock dblock mentioned this pull request Sep 23, 2021
1 task
@dblock dblock requested a review from peternied September 23, 2021 16:12
Signed-off-by: Himanshu Setia <setiah@amazon.com>
Copy link
Member

@saratvemulapalli saratvemulapalli left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@dblock dblock merged commit df1b212 into opensearch-project:main Sep 23, 2021
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.

4 participants