Skip to content

Commit

Permalink
Merge pull request #1279 from marquiz/docs/version-policy
Browse files Browse the repository at this point in the history
docs: document version and deprecation policy
  • Loading branch information
k8s-ci-robot committed Jul 21, 2023
2 parents 5223d1f + f825812 commit e195e85
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/reference/versions.md
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**.

0 comments on commit e195e85

Please sign in to comment.