From 292efe2040ca2c9235a1fb9a915cfbde0e3caadc Mon Sep 17 00:00:00 2001 From: Sarat Vemulapalli Date: Thu, 13 Jan 2022 07:01:54 -0800 Subject: [PATCH] Added help to build distributions in docs (#1898) Signed-off-by: Sarat Vemulapalli --- DEVELOPER_GUIDE.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index de8bbbfa245..381c7c64077 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -7,6 +7,7 @@ - [Runtime JDK](#runtime-jdk) - [Windows](#windows) - [Docker](#docker) + - [Build](#build) - [Run Tests](#run-tests) - [Run OpenSearch](#run-opensearch) - [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. +### 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 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 -The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport ` 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. \ No newline at end of file +The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport ` 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.