From 6f0e3458cc81a9f6e47d6228a729dca9a98704db Mon Sep 17 00:00:00 2001 From: Mirko von Leipzig Date: Tue, 4 Mar 2025 15:55:40 +0200 Subject: [PATCH] versioning --- docs/src/operator/versioning.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/src/operator/versioning.md b/docs/src/operator/versioning.md index e69de29bb..f32c59bd3 100644 --- a/docs/src/operator/versioning.md +++ b/docs/src/operator/versioning.md @@ -0,0 +1,13 @@ +# Versioning + +We follow the [semver](https://semver.org/) standard for versioning. + +The following is considered the node's public API, and will therefore be considered as breaking changes. + +- RPC gRPC specification (note that this _excludes_ inter-component gRPC schemas). +- Node configuration options. +- Database schema changes. + +We intend to include our OpenTelemetry trace specification in this once it standardizes. + +We _will_ also call out non-breaking behvioral changes in our changelog and release notes.