Skip to content

Commit 38c4224

Browse files
committed
doc: add a section about release procedures
Signed-off-by: Tuomas Katila <[email protected]>
1 parent 40844f8 commit 38c4224

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Table of Contents
2727
* [Demos](#demos)
2828
* [Workload Authors](#workload-authors)
2929
* [Developers](#developers)
30-
* [Supported Kubernetes versions](#supported-kubernetes-versions)
30+
* [Releases](#releases)
31+
* [Supported Kubernetes versions](#supported-kubernetes-versions)
32+
* [Release procedures](#release-procedures)
3133
* [Pre-built plugin images](#pre-built-plugin-images)
3234
* [License](#license)
3335
* [Helm charts](#helm-charts)
@@ -255,7 +257,9 @@ The summary of resources available via plugins in this repository is given in th
255257
For information on how to develop a new plugin using the framework or work on development task in
256258
this repository, see the [Developers Guide](DEVEL.md).
257259

258-
## Supported Kubernetes Versions
260+
## Releases
261+
262+
### Supported Kubernetes Versions
259263

260264
Releases are made under the github [releases area](https://github.com/intel/intel-device-plugins-for-kubernetes/releases). Supported releases and
261265
matching Kubernetes versions are listed below:
@@ -279,6 +283,16 @@ matching Kubernetes versions are listed below:
279283
[Go environment]: https://golang.org/doc/install
280284
[Kubernetes cluster]: https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/
281285

286+
### Release procedures
287+
288+
Project's release cadence is tied to Kubernetes release cadence. Device plugins release typically follows a couple of weeks after the Kubernetes release. There can be some delays on the releases due to required changes in the pull request pipeline. Once the content is available in the `main` branch and CI & e2e validation <span style="color:green">PASS</span>es, release branch will be created (e.g. release-0.26). The HEAD of release branch will also be tagged with the corresponding [tag](https://github.com/intel/intel-device-plugins-for-kubernetes/tags) (e.g. v0.26.0).
289+
290+
During the [release creation](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1393), the project's documentation, deployment files etc. will be [changed](https://github.com/intel/intel-device-plugins-for-kubernetes/pull/1441) to point to the newly created version.
291+
292+
Pull requests that are required for specific release are labeled with the corresponding [milestone](https://github.com/intel/intel-device-plugins-for-kubernetes/milestones).
293+
294+
Patch releases (e.g. 0.26.3) are done on an adhoc basis if there are security issues or minor fixes requested for specific version.
295+
282296
## Pre-built plugin images
283297

284298
Pre-built images of the plugins are available on the Docker hub. These images

0 commit comments

Comments
 (0)