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

Update README to include more context and plugin onboarding steps. #309

Merged
merged 1 commit into from
Sep 21, 2021

Conversation

mch2
Copy link
Member

@mch2 mch2 commented Aug 24, 2021

Description

Update README to include more context on the build system and plugin onboarding steps.

Issues Resolved

Related #73

Check List

  • [ x] 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.


## 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
Copy link
Member

Choose a reason for hiding this comment

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

@setiah @CEHENKLE This is very much design doc turned into documentation and does a great job at explaining what we have in the best place possible, next to the code, therefore I don't see why we need another doc checked into the repo that duplicates the code and its documentation

bundle-workflow/README.md Outdated Show resolved Hide resolved
Copy link
Member

@dblock dblock left a 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

bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
@peternied
Copy link
Member

Just started to onboard everyone to the new process, could we get this PR refreshed so we can point them to this doc?

@codecov-commenter
Copy link

codecov-commenter commented Sep 20, 2021

Codecov Report

Merging #309 (fdd0e65) into main (0ac7e2b) will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
bundle-workflow/src/manifests/test_manifest.py 100.00% <0.00%> (ø)
...w/src/test_workflow/integ_test/integ_test_suite.py 0.00% <0.00%> (ø)

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 0ac7e2b...fdd0e65. Read the comment docs.

@mch2
Copy link
Member Author

mch2 commented Sep 20, 2021

Sorry for the lag here - updated.

Copy link
Member

@dblock dblock left a 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.

bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
bundle-workflow/README.md Outdated Show resolved Hide resolved
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.
Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Member Author

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>
@mch2 mch2 merged commit a4205d1 into opensearch-project:main Sep 21, 2021
@mch2 mch2 deleted the onboarding branch September 21, 2021 20:51
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