Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: explicitly mention deviations from semver #1689

Merged
merged 4 commits into from
Sep 18, 2024
Merged

docs: explicitly mention deviations from semver #1689

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f7287eb
docs: explicitly mention deviations from semver
morremeyer Sep 16, 2024
8deef0b
Update docs/sources/introduction/backward-compatibility.md
morremeyer Sep 17, 2024
66431a5
Update docs/sources/introduction/backward-compatibility.md
morremeyer Sep 17, 2024
f2a9e7b
Update docs/sources/introduction/backward-compatibility.md
morremeyer Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/sources/introduction/backward-compatibility.md
View file
Open in desktop
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" >}} mostly follows [semantic versioning][], with the differences documented in the [Exceptions](#exceptions) section.
morremeyer marked this conversation as resolved.
Show resolved Hide resolved
{{< 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]:
morremeyer marked this conversation as resolved.
Show resolved Hide resolved

* **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
Loading