Skip to content

Commit

Permalink
docs: explicitly mention deviations from semver (#1689)
Browse files Browse the repository at this point in the history
Co-authored-by: William Dumont <william.dumont@grafana.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
  • Loading branch information
3 people authored Sep 18, 2024
1 parent 3cabf05 commit ba348ea
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/sources/introduction/backward-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 999

# {{% param "FULL_PRODUCT_NAME" %}} backward compatibility

{{< param "FULL_PRODUCT_NAME" >}} follows [semantic versioning][].
{{< param "FULL_PRODUCT_NAME" >}} follows [semantic versioning][]. [Exceptions](#exceptions) may arise that require a breaking change without a new major version.
{{< param "PRODUCT_NAME" >}} is stable, and we strive to maintain backward compatibility between minor and patch versions.

Documented functionality that's released as _Generally available_ is covered by backward compatibility, including:
Expand All @@ -21,7 +21,7 @@ Documented functionality that's released as _Generally available_ is covered by

## Exceptions

We strive to maintain backward compatibility, but there are situations that may arise that require a breaking change without a new major version:
We strive to maintain backward compatibility, but there are situations that may arise that require a breaking change without a new major version, deviating from [item 8 of the semver specification][]:

* **Security**: A security issue may arise that requires breaking compatibility.

Expand All @@ -38,4 +38,5 @@ We strive to maintain backward compatibility, but there are situations that may
We try, whenever possible, to resolve these issues without breaking compatibility.

[semantic versioning]: https://semver.org/
[item 8 of the semver specification]: https://semver.org/spec/v2.0.0.html#spec-item-8
[alloy-mixin]: https://github.com/grafana/alloy/tree/main/operations/alloy-mixin

0 comments on commit ba348ea

Please sign in to comment.