Skip to content

Commit 26256ac

Browse files
committed
Add version stability disclaimer to README
As requested by @butonic in PR opencloud-eu#43, this adds a clear warning about the 0.x.x version status according to SemVer 2.0 spec item 4. This helps users understand that: - Charts are under heavy development - Breaking changes may occur at any time - API is not stable yet - Production use requires caution
1 parent 33ac358 commit 26256ac

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,16 @@ The current maintainers and reviewers are listed in [MAINTAINERS.md](./MAINTAINE
7070
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
7171
- External ingress controller (e.g., Cilium Gateway API) for routing traffic to the services
7272

73+
## ⚠️ Version Stability Notice
74+
75+
**Important**: These Helm charts are currently at version `0.x.x`, which according to [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html#spec-item-4) means:
76+
- The charts are still under heavy development
77+
- Breaking changes may occur at any time
78+
- The public API should not be considered stable
79+
- Use with caution in production environments
80+
81+
We recommend pinning to specific chart versions and thoroughly testing updates before applying them.
82+
7383
## 📦 Available Charts
7484

7585
This repository contains the following charts:

0 commit comments

Comments
 (0)