ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-01-02 03:56:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1809 from balena-io/1802-deprecation-policy

Browse Source 
Add a deprecation policy
This commit is contained in:
Thodoris Greasidis 2020-05-11 15:30:30 +03:00 committed by GitHub
commit d7021a556e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -140,6 +140,22 @@ If you come across any problems or would like to get in touch:
* For bug reports or feature requests, * 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/). [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) ## Contributing (including editing documentation files)
Please have a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file for some guidance before Please have a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file for some guidance before

1
automation/capitanodoc/capitanodoc.ts
View File

@ -160,6 +160,7 @@ export async function getCapitanoDoc(): Promise<typeof capitanoDoc> {
mdParser.getSectionOfTitle('Installation'), mdParser.getSectionOfTitle('Installation'),
mdParser.getSectionOfTitle('Getting Started'), mdParser.getSectionOfTitle('Getting Started'),
mdParser.getSectionOfTitle('Support, FAQ and troubleshooting'), mdParser.getSectionOfTitle('Support, FAQ and troubleshooting'),
mdParser.getSectionOfTitle('Deprecation policy'),
]); ]);
capitanoDoc.introduction = sections.join('\n'); capitanoDoc.introduction = sections.join('\n');
return capitanoDoc; return capitanoDoc;

16
doc/cli.markdown
View File

@ -128,6 +128,22 @@ If you come across any problems or would like to get in touch:
* For bug reports or feature requests, * 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/). [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 # CLI Command Reference