Skip to content

Commit e49da24

Browse files
committed
[DOCS] Updates CONTRIBUTING, adds Serverless tests information
1 parent d9b3ee4 commit e49da24

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,20 @@ rake test:yaml
7272

7373
Check `rake -T` for more test tasks.
7474

75+
## Testing Serverless
76+
77+
To run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) Serverless specific test suite, the following environment variables must be provided:
78+
* `TEST_SUITE` must be set to `serverless`.
79+
* `TEST_ES_SERVER` must be provided with the Elasticsearch endpoint.
80+
* `ES_API_KEY` the API key value for your Serverless project.
81+
82+
```
83+
TEST_SUITE=serverless \
84+
ES_API_KEY=YOUR_SERVERLESS_API_KEY \
85+
TEST_ES_SERVER='ELASTICSEARCH_SERVERLESS_ENDPOINT' \
86+
rake test:yaml
87+
```
88+
7589
# Contributing
7690

7791
The process for contributing to any of the [Elasticsearch](https://github.com/elasticsearch) repositories is similar:

0 commit comments

Comments
 (0)