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

Adding missing steps to DEVELOPER_GUIDE.md #194

Merged
merged 4 commits into from
Dec 5, 2023
Merged

Adding missing steps to DEVELOPER_GUIDE.md #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6c14c8
initial proposal of change
AbhinavGarg90 Oct 17, 2023
d81b4e5
appended changelog
AbhinavGarg90 Oct 17, 2023
35a7405
fixed changelog and specified distro
AbhinavGarg90 Dec 5, 2023
c8a5434
fixed merge issues
AbhinavGarg90 Dec 5, 2023
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,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))
[Unreleased]: https://github.com/opensearch-project/opensearch-rs/compare/v2.2.0...HEAD
[2.2.0]: https://github.com/opensearch-project/opensearch-rs/compare/v2.1.0...v2.2.0
[2.1.0]: https://github.com/opensearch-project/opensearch-rs/compare/v2.0.0...v2.1.0
18 changes: 16 additions & 2 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,20 @@ 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:
dblock marked this conversation as resolved.
Show resolved Hide resolved

Linux
- `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).
Expand All @@ -58,13 +72,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
Expand Down
Loading