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

Add new workflow to verify binary install #306

Merged
merged 2 commits into from
Mar 13, 2024

Conversation

derek-ho
Copy link
Contributor

@derek-ho derek-ho commented Feb 26, 2024

Description

I have observed some issues within other plugins of issues being only caught at run time. This is because several things can go wrong during the build process, which may not be caught in a dev setup. This adds a workflow to verify that building and installing into OSD works on every PR.

Related issues:
opensearch-project/security-dashboards-plugin#1709
opensearch-project/security-analytics-dashboards-plugin#875
opensearch-project/dashboards-observability#309
opensearch-project/OpenSearch-Dashboards#5952

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.29%. Comparing base (ad42589) to head (13b6fbc).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #306   +/-   ##
=======================================
  Coverage   80.29%   80.29%           
=======================================
  Files          26       26           
  Lines         477      477           
  Branches      105      105           
=======================================
  Hits          383      383           
  Misses         67       67           
  Partials       27       27           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Derek Ho <[email protected]>
@derek-ho
Copy link
Contributor Author

Workflow is failing due to core issue

@ruanyl
Copy link
Member

ruanyl commented Feb 27, 2024

I'm curious if the errors mentioned in related issues were captured by integration tests?

@derek-ho
Copy link
Contributor Author

Yes it should. The purpose of this workflow is to move the failures up in the development lifecycle. Instead of retroactively fixing issues hopefully this will keep the branches in good shape and keep folks aware of any build failures in core. Thus auto cuts/integration failures can be taken more seriously and be focused on actual test failures and not issues with the build process.

plugin_name: ml-commons-dashboards
built_plugin_name: mlCommonsDashboards
built_plugin_suffix: ${{ env.OPENSEARCH_VERSION }}
install_zip: true
Copy link
Member

Choose a reason for hiding this comment

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

Which version of the plugin will be installed via the zip? Is it built from the source of the current branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea the workflow checks out the current branch and then builds/installs the zip into OSD on the same version/branch. Source code here: https://github.com/derek-ho/setup-opensearch-dashboards/blob/main/action.yml#L69. The setups and versions passed here are only to help the command to install, since some plugins are doing custom renaming/may have custom version suffix, i.e. 3.0.0 vs 3.0.0.0

@wanglam wanglam merged commit 78303d5 into opensearch-project:main Mar 13, 2024
9 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 13, 2024
* Add new workflow to verify binary install

Signed-off-by: Derek Ho <[email protected]>

* Fix zip name

Signed-off-by: Derek Ho <[email protected]>

---------

Signed-off-by: Derek Ho <[email protected]>
(cherry picked from commit 78303d5)
wanglam pushed a commit that referenced this pull request Mar 18, 2024
* Add new workflow to verify binary install

Signed-off-by: Derek Ho <[email protected]>

* Fix zip name

Signed-off-by: Derek Ho <[email protected]>

---------

Signed-off-by: Derek Ho <[email protected]>
(cherry picked from commit 78303d5)

Co-authored-by: Derek Ho <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants