-
Notifications
You must be signed in to change notification settings - Fork 282
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
Conversation
Signed-off-by: Himanshu Setia <setiah@amazon.com>
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing a period :)
Signed-off-by: Himanshu Setia <setiah@amazon.com>
There was a problem hiding this 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!
Signed-off-by: Himanshu Setia setiah@amazon.com
Issues Resolved
#558
Check List
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.