honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added help to build distributions in docs (#1898) 

Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
This commit is contained in:
Sarat Vemulapalli 2022-01-13 07:01:54 -08:00 committed by GitHub
parent cfc9ec292d
commit 292efe2040
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
DEVELOPER_GUIDE.md
View File

@ -7,6 +7,7 @@
- [Runtime JDK](#runtime-jdk) - [Runtime JDK](#runtime-jdk)
- [Windows](#windows) - [Windows](#windows)
- [Docker](#docker) - [Docker](#docker)
- [Build](#build)
- [Run Tests](#run-tests) - [Run Tests](#run-tests)
- [Run OpenSearch](#run-opensearch) - [Run OpenSearch](#run-opensearch)
- [Use an Editor](#use-an-editor) - [Use an Editor](#use-an-editor)
@ -82,6 +83,22 @@ Download and install [Docker](https://docs.docker.com/install/), required for bu
On Windows, [use Docker Desktop 3.6](https://docs.docker.com/desktop/windows/release-notes/3.x/). See [OpenSearch#1425](https://github.com/opensearch-project/OpenSearch/issues/1425) for workarounds and issues with Docker Desktop 4.1.1. On Windows, [use Docker Desktop 3.6](https://docs.docker.com/desktop/windows/release-notes/3.x/). See [OpenSearch#1425](https://github.com/opensearch-project/OpenSearch/issues/1425) for workarounds and issues with Docker Desktop 4.1.1.
### Build
To build all distributions of OpenSearch, run:
```
./gradlew assemble
```
To build a distribution to run on your local platform, run:
```
./gradlew localDistro
```
All distributions built will be under `distributions/archives`.
### Run Tests ### Run Tests
OpenSearch uses a Gradle wrapper for its build. Run `gradlew` on Unix systems, or `gradlew.bat` on Windows in the root of the repository. OpenSearch uses a Gradle wrapper for its build. Run `gradlew` on Unix systems, or `gradlew.bat` on Windows in the root of the repository.
@ -412,4 +429,4 @@ See [CONTRIBUTING](CONTRIBUTING.md).
## Backports ## Backports
The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport <backport-branch-name>` is merged to main with the backport workflow run successfully on the PR. For example, if a PR on main needs to be backported to `1.x` branch, add a label `backport 1.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 `1.x` branch. The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport <backport-branch-name>` is merged to main with the backport workflow run successfully on the PR. For example, if a PR on main needs to be backported to `1.x` branch, add a label `backport 1.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 `1.x` branch.