actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add developer guide (#57)

Browse Source 
Signed-off-by: Rushi Agrawal <rushi.agr@gmail.com>
This commit is contained in:
Rushi Agrawal
2021-08-31 19:42:26 +05:30
committed by GitHub
parent 1212df567b
commit 28547f5a9a
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEVELOPER_GUIDE.md
+22
View File
@@ -0,0 +1,22 @@
Run the linter and test suite to ensure your changes do not break existing code:
```
# Install Nox for task management
$ python -m pip install nox
# Auto-format and lint your changes
$ nox -rs format
# Run the test suite
$ nox -rs test
```
To run the integration tests locally, run:
```
./.ci/run-tests opensearch true
```
The first argument, `opensearch` tells the server type to run integration test against. Valid values are `opensearch` and `opendistro`. The second argument tells whether to run server with security plugin enabled or not.
Note that integration tests require docker to be installed and running, and downloads quite a bit of data from over the internet and hence take few minutes to complete.