From e6c14c8385a1829e316d94d0ee40a8be87a465ac Mon Sep 17 00:00:00 2001 From: Abhinav Garg Date: Tue, 17 Oct 2023 17:55:12 -0500 Subject: [PATCH 1/3] initial proposal of change Signed-off-by: Abhinav Garg --- DEVELOPER_GUIDE.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 9a24f270..97ec7d19 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -47,6 +47,18 @@ The following information will help in getting up and running. cargo install --force cargo-make ``` +- [**Packages**]() + + Use your preferred package manager to install the following packages: + - `build-essential` + - `pkg-config` + - `libssl-dev` + + Example using apt: + ```sh + sudo apt install build-essential pkg-config libssl-dev + ``` + - [**Docker**](https://www.docker.com/) Docker is used to start instances of OpenSearch required for integration tests using [OpenSearch docker images](https://hub.docker.com/r/opensearchproject/opensearch). @@ -58,13 +70,13 @@ The following information will help in getting up and running. Run unit tests. ```sh -cargo test +cargo make test ``` To include optional features, such as AWS auth use the following. ```sh -cargo test --features "aws-auth" +cargo make test --features "aws-auth" ``` ### Cargo Make From d81b4e5fd389c82d79354147e34e43be5f90b1d6 Mon Sep 17 00:00:00 2001 From: Abhinav Garg Date: Tue, 17 Oct 2023 18:05:35 -0500 Subject: [PATCH 2/3] appended changelog Signed-off-by: Abhinav Garg --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 29050684..a792d52e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -61,7 +61,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Fixes `cargo make test` failing out of the box ([#117](https://github.com/opensearch-project/opensearch-rs/pull/117)) - Fixes f64 comparison in `yaml_test_runner` to use numeric-based comparison instead of string-based ([#150](https://github.com/opensearch-project/opensearch-rs/pull/150)) - Fixes YAML spec tests by adding u64 (unsigned long) support ([#167](https://github.com/opensearch-project/opensearch-rs/pull/167)) - +- Fixes `DEVELOPER_GUIDE.md` to include complete information about setting up([#194](https://github.com/opensearch-project/opensearch-rs/pull/194)) ### Security [Unreleased]: https://github.com/opensearch-project/opensearch-rs/compare/v2.1.0...HEAD From 35a740596074ba92f7923a7fbe73de8768586daf Mon Sep 17 00:00:00 2001 From: Abhinav Garg Date: Mon, 4 Dec 2023 19:07:36 -0600 Subject: [PATCH 3/3] fixed changelog and specified distro Signed-off-by: Abhinav Garg --- CHANGELOG.md | 2 +- DEVELOPER_GUIDE.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a792d52e..fbf9b290 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -61,7 +61,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Fixes `cargo make test` failing out of the box ([#117](https://github.com/opensearch-project/opensearch-rs/pull/117)) - Fixes f64 comparison in `yaml_test_runner` to use numeric-based comparison instead of string-based ([#150](https://github.com/opensearch-project/opensearch-rs/pull/150)) - Fixes YAML spec tests by adding u64 (unsigned long) support ([#167](https://github.com/opensearch-project/opensearch-rs/pull/167)) -- Fixes `DEVELOPER_GUIDE.md` to include complete information about setting up([#194](https://github.com/opensearch-project/opensearch-rs/pull/194)) +- Fixes `DEVELOPER_GUIDE.md` to include complete information about setting up ([#194](https://github.com/opensearch-project/opensearch-rs/pull/194)) ### Security [Unreleased]: https://github.com/opensearch-project/opensearch-rs/compare/v2.1.0...HEAD diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 97ec7d19..5f614b08 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -50,6 +50,8 @@ The following information will help in getting up and running. - [**Packages**]() Use your preferred package manager to install the following packages: + + Linux - `build-essential` - `pkg-config` - `libssl-dev`