Skip to content

Commit 749b081

Browse files
committed
Add versioning section to readme and docs
1 parent 21c028c commit 749b081

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,20 @@ or
99
**for a free trial of Elastic Cloud**.
1010

1111
The .NET client for Elasticsearch provides strongly typed requests and responses
12-
for Elasticsearch APIs. It delegates protocol handling to the
13-
[Elastic.Transport](https://github.com/elastic/elastic-transport-net) library,
12+
for Elasticsearch APIs. It delegates protocol handling to the
13+
[Elastic.Transport](https://github.com/elastic/elastic-transport-net) library,
1414
which takes care of all transport-level concerns (HTTP connection establishment
1515
and pooling, retries, etc.).
1616

17+
## Versioning
18+
19+
The *major* and *minor* version parts of the Elasticsearch .NET client are dictated by the version of the Elasticsearch server.
20+
21+
> [!WARNING]
22+
> This means that the Elasticsearch .NET client **does not** strictly follows semantic versioning!
23+
>
24+
> Although we try to avoid this as much as possible, it can happen that a *minor* or even *patch* version contains breaking changes. Please always check the release notes before updating the client package.
25+
1726
## Compatibility
1827

1928
Language clients are **forward compatible**:

docs/reference/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ The .NET {{es}} client is built on the Elastic Transport library, which provides
2727
* Connection management and load balancing across all available nodes.
2828
* Request retries and dead connections handling.
2929

30+
## Versioning [versioning]
31+
32+
The *major* and *minor* version parts of the Elasticsearch .NET client are dictated by the version of the Elasticsearch server.
33+
34+
:::{warning}
35+
36+
This means that the Elasticsearch .NET client **does not** strictly follows semantic versioning!
37+
38+
Although we try to avoid this as much as possible, it can happen that a *minor* or even *patch* version contains breaking changes. Please always check the release notes before updating the client package.
39+
40+
:::
41+
3042
## {{es}} version compatibility [_es_version_compatibility]
3143

3244
Language clients are **forward compatible**:

0 commit comments

Comments
 (0)