-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1279 from marquiz/docs/version-policy
docs: document version and deprecation policy
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: "Versions" | ||
layout: default | ||
sort: 8 | ||
--- | ||
|
||
# Versions and deprecation | ||
{: .no_toc} | ||
|
||
--- | ||
|
||
## Supported versions | ||
|
||
Node Feature Discovery follows [semantic versioning](https://semver.org/) where | ||
the version number consists of three components, i.e. **MAJOR.MINOR.PATCH**. | ||
|
||
The most recent two minor releases (or release branches) of Node Feature | ||
Discovery are supported. That is, with X being the latest release, **X** and **X-1** | ||
are supported and **X-1** reaches end-of-life when **X+1** is released. | ||
|
||
## Deprecation policy | ||
|
||
### Feature labels | ||
|
||
Built-in [feature labels](../usage/features.md) and | ||
[features](../usage/customization-guide.html#available-features) are supported | ||
for 2 releases after being deprecated, at minimum. That is, if a feature label | ||
is deprecated in version **X**, it will be supported in **X+1** and **X+2** and | ||
may be dropped in **X+3**. | ||
|
||
### Configuration options | ||
|
||
Command-line flags and configuration file options are supported for 1 more | ||
release after being deprecated, at minimum. That is, if option/flag is | ||
deprecated in version **X**, it will be supported in **X+1** and may be removed | ||
in **X+2**. |