-
Notifications
You must be signed in to change notification settings - Fork 273
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
Update README to include more context and plugin onboarding steps. #309
Conversation
|
||
## OpenSearch Bundle Workflow | ||
|
||
This workflow builds a complete OpenSearch bundle from source. You can currently build 1.0, 1.1 and 1.1-SNAPSHOT. | ||
|
||
### How it works |
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.
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.
Added some more specific asks from looking at #315
Just started to onboard everyone to the new process, could we get this PR refreshed so we can point them to this doc? |
Codecov Report
@@ Coverage Diff @@
## main #309 +/- ##
==========================================
- Coverage 69.65% 69.62% -0.03%
==========================================
Files 59 59
Lines 1575 1577 +2
==========================================
+ Hits 1097 1098 +1
- Misses 478 479 +1
Continue to review full report at Codecov.
|
Sorry for the lag here - updated. |
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.
Definitely fix merge conflict leftovers.
5. Execute ./bundle-workflow/assemble.sh to ensure the full bundle is assembled and placed in to /bundles/*.tar.gz. Unpack the tarball | ||
to ensure all your components are placed in their correct locations. | ||
|
||
6. Publish a PR to this repo including the updated manifest and the names of the artifacts being added. |
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.
I don't love these steps. We want components to check that they can run ./bundle-workflow/build.sh manifests/1.1.0/opensearch-1.1.0 --snapshot
end-to-end successfully. They can iterate with --component name
to debug.
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.
I can add a step for this explicitly, is there a step here you think can be removed?
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.
Actually I'd rather merge this as is and have that updated when we merge this with #528
Signed-off-by: Marc Handalian <handalm@amazon.com>
Description
Update README to include more context on the build system and plugin onboarding steps.
Issues Resolved
Related #73
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.