From 9412a21d40be5368866d754d66cf19443df51662 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Mon, 11 May 2020 11:12:27 +0300 Subject: [PATCH] Add a deprecation policy Resolves: #1802 Change-type: minor See: https://app.frontapp.com/open/cnv_7d92qx9 HQ: https://github.com/balena-io/balena/issues/2032 See: https://www.flowdock.com/app/rulemotion/r-product/threads/A6-bJBldfUFnhG9vixTz-DLz9iB Signed-off-by: Thodoris Greasidis --- README.md | 16 ++++++++++++++++ automation/capitanodoc/capitanodoc.ts | 1 + doc/cli.markdown | 16 ++++++++++++++++ 3 files changed, 33 insertions(+) diff --git a/README.md b/README.md index ad5c8534..84d6c0a4 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,22 @@ If you come across any problems or would like to get in touch: * For bug reports or feature requests, [have a look at the GitHub issues or create a new one](https://github.com/balena-io/balena-cli/issues/). +## Deprecation policy + +The balena CLI uses [semver versioning](https://semver.org/), with the concepts +of major, minor and patch version releases. + +The latest release of the previous major version of the balena CLI will remain +compatible with the balenaCloud backend services for one year from the date when +the next major version is released. For example, balena CLI v10.17.5, as the +latest v10 release, would remain compatible with the balenaCloud backend for one +year from the date when v11.0.0 is released. + +At the end of this period, the older major version is considered deprecated and +some of the functionality that depends on balenaCloud services may stop working +at any time. +Users are encouraged to regularly update the balena CLI to the latest version. + ## Contributing (including editing documentation files) Please have a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file for some guidance before diff --git a/automation/capitanodoc/capitanodoc.ts b/automation/capitanodoc/capitanodoc.ts index 749685f0..eb014a4b 100644 --- a/automation/capitanodoc/capitanodoc.ts +++ b/automation/capitanodoc/capitanodoc.ts @@ -160,6 +160,7 @@ export async function getCapitanoDoc(): Promise { mdParser.getSectionOfTitle('Installation'), mdParser.getSectionOfTitle('Getting Started'), mdParser.getSectionOfTitle('Support, FAQ and troubleshooting'), + mdParser.getSectionOfTitle('Deprecation policy'), ]); capitanoDoc.introduction = sections.join('\n'); return capitanoDoc; diff --git a/doc/cli.markdown b/doc/cli.markdown index cc72f6bc..ca9e13f5 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -128,6 +128,22 @@ If you come across any problems or would like to get in touch: * For bug reports or feature requests, [have a look at the GitHub issues or create a new one](https://github.com/balena-io/balena-cli/issues/). +## Deprecation policy + +The balena CLI uses [semver versioning](https://semver.org/), with the concepts +of major, minor and patch version releases. + +The latest release of the previous major version of the balena CLI will remain +compatible with the balenaCloud backend services for one year from the date when +the next major version is released. For example, balena CLI v10.17.5, as the +latest v10 release, would remain compatible with the balenaCloud backend for one +year from the date when v11.0.0 is released. + +At the end of this period, the older major version is considered deprecated and +some of the functionality that depends on balenaCloud services may stop working +at any time. +Users are encouraged to regularly update the balena CLI to the latest version. + # CLI Command Reference