Skip to content

adding verification script - #712

Open
MarkWolters wants to merge 1 commit into
mainfrom
native_lib_verify_script
Open

adding verification script#712
MarkWolters wants to merge 1 commit into
mainfrom
native_lib_verify_script

Conversation

@MarkWolters

Copy link
Copy Markdown
Contributor

This PR adds one new script, verify_native_lib.sh, to the jvector-native module. The purpose of this script is to verify that the libjvector.so shared library has been correctly generated and contains the expected content prior to pushing a release to Sonatype (although it can also be used ad hoc at any time).

This PR contains no code changes or modifications to existing files.

Release instructions at https://github.com/riptano/VECTOR-SEARCH/blob/main/teamdocs/jvector_releases_admin.md have been updated to include a step for this check.

@github-actions

Copy link
Copy Markdown
Contributor

Before you submit for review:

  • Does your PR follow guidelines from CONTRIBUTIONS.md?
  • Did you summarize what this PR does clearly and concisely?
  • Did you include performance data for changes which may be performance impacting?
  • Did you include useful docs for any user-facing changes or features?
  • Did you include useful javadocs for developer oriented changes, explaining new concepts or key changes?
  • Did you rebase your branch onto the latest main for regression testing and PR submission?
  • Did you trigger regression testing via Run Bench Main and review results?
  • Did you adhere to the code formatting guidelines (TBD)
  • Did you group your changes for easy review, providing meaningful descriptions for each commit?
  • Did you ensure that all files contain the correct copyright header?
  • Did you add documentation for this feature to the release notes directory?

If you did not complete any of these, then please explain below.

@r-devulap r-devulap left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

fi

echo "-- exported symbols (nm) --"
REQUIRED_SYMBOLS=(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe add a comment explaining that an exhaustive list is not required here. Successful loading of the .so is sufficient, since the Java side will fail if any expected kernel API is missing. This would also clarify that the list does not need to be maintained as additional kernels are introduced.

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.

2 participants