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.

Sign up for GitHub

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

[documentation] Adds documentation to help fix local Lucene code errors #928

Merged
merged 4 commits into from
Oct 11, 2024
Merged

[documentation] Adds documentation to help fix local Lucene code errors #928

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7645653
Adds documentation to help fix local Lucene code errors
brianf-aws Oct 10, 2024
9ed2f63
Update dev guide to be more specific on KNN dependency issue
brianf-aws Oct 11, 2024
b6624ba
Added lucene doc help to table of contents
brianf-aws Oct 11, 2024
a4445a3
Added Major Dependencies Info under Debuging
brianf-aws Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,22 @@ Please follow these formatting guidelines:
OpenSearch neural-search uses a [Gradle](https://docs.gradle.org/6.6.1/userguide/userguide.html) wrapper for its build.
Run `gradlew` on Unix systems.

Build OpenSearch neural-search using `gradlew build`
Build OpenSearch neural-search using `gradlew build`. This command will
also run Integration Tests and Unit Tests.
brianf-aws marked this conversation as resolved.
Show resolved Hide resolved

```
./gradlew build
```

## Run Unit Tests
If you want to strictly test that your unit tests are passing
you can run the following.

```
./gradlew test
```


## Run OpenSearch neural-search

### Run Single-node Cluster Locally
Expand Down Expand Up @@ -292,3 +302,28 @@ original PR with an appropriate label `backport <backport-branch-name>` is merge
run successfully on the PR. For example, if a PR on main needs to be backported to `2.x` branch, add a label
`backport 2.x` to the PR and make sure the backport workflow runs on the PR along with other checks. Once this PR is
merged to main, the workflow will create a backport PR to the `2.x` branch.

## Building on Lucene Version updates
There may be a Lucene version update that can affect your workflow causing errors like
`java.lang.NoClassDefFoundError: org/apache/lucene/codecs/lucene99/Lucene99Codec`.
This results in having issues with not being able to do `./gradlew run` or `./gradlew build`.

You can check this [PR](https://github.com/opensearch-project/k-NN/pull/2195) as an example of this event happening
brianf-aws marked this conversation as resolved.
Show resolved Hide resolved

**Follow the steps to remedy the gradle run issue.**
brianf-aws marked this conversation as resolved.
Show resolved Hide resolved
1. From your cloned neural search repo root directory `rm -rf build .gradle`
2. Clear the following directories from your gradle folder located in your root directory
1. `cd ~/.gradle`
2. `rm -rf caches workers wrapper daemon`
3. `cd -` switch back the previous directory (i.e. the neural search repo root directory)
3. Finally run `./gradlew run`

**Follow the steps to remedy the gradle build issue**

**PREREQ:** Make sure you have OpenSearch repo cloned locally

1. From your cloned neural search repo root directory `rm -rf build .gradle`
2. Delete the .gradle folder and .m2 folder. `rm -rf ~/.gradle ~/.m2`
3. Head over to your OpenSearch cloned repo root directory
1. `./gradlew publisToMavenLocal`
4. Finally run `./gradlew build` from the neural search repo
Loading