Skip to content

Commit 6e0dd4c

Browse files
committed
Versioning section small refactor
1 parent 92f94ee commit 6e0dd4c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/sources/k6/next/reference/versioning-and-stability-guarantees.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,23 @@ If you believe an API should be added to this allow list but is currently missin
2222

2323
k6 strictly follows [Semantic Versioning 2.0.0](https://semver.org/) versioning scheme. This versioning scheme defines three kinds of software versions.
2424

25-
#### Major version
25+
### Breaking change
26+
27+
As per the [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) specification, we define a breaking change as a change to k6 that's not backward compatible.
28+
29+
Breaking changes imply that the consumer of k6 is expected to make some effort to adapt to the changes being made.
30+
31+
Although it's possible that, in certain cases, the new major version containing breaking changes might be compatible with the previous version, this isn't expected.
32+
33+
### Major version
2634

2735
A major version contains backward incompatible API changes.
2836

2937
Quoting the [SemVer 2.0.0 specification on major versions](https://semver.org/#spec-item-8) directly:
3038

3139
> *Major version X (X.y.z | X \> 0\) **MUST** be incremented if any backward-incompatible changes are introduced to the public API. This may also include minor and patch-level changes. Patch and minor versions **MUST** be reset to 0 when the major version is incremented.*
3240
33-
#### Minor version
41+
### Minor version
3442

3543
A minor version contains backward-compatible API additions/changes.
3644

@@ -41,22 +49,14 @@ Quoting the [SemVer 2.0.0 specification on minor versions](https://semver.org/#s
4149
> *It MAY be incremented if substantial new functionality or improvements are introduced within the private code.*
4250
> *It MAY include patch-level changes. The patch version MUST be reset to 0 when the minor version is incremented.*
4351
44-
#### Patch version
52+
### Patch version
4553

4654
A patch version contains bug fixes **that do not affect** the API.
4755

4856
Quoting the [SemVer 2.0.0 specification on patch versions](https://semver.org/#spec-item-6) directly:
4957

5058
> *Patch version Z (x.y.Z | x \> 0\) **MUST** be incremented if only backward compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.*
5159
52-
### Breaking change
53-
54-
As per the [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) specification, we define a breaking change as a change to k6 that's not backward compatible.
55-
56-
Breaking changes imply that the consumer of k6 is expected to make some effort to adapt to the changes being made.
57-
58-
Although it's possible that, in certain cases, the new major version containing breaking changes might be compatible with the previous version, this isn't expected.
59-
6060
## Release strategy
6161

6262
A k6 release is a set of changes that updates or adds new functionalities to the product, made globally available under a unique and new identifiable version.

0 commit comments

Comments
 (0)