From 0b6acd512edba57786bf98ffc67c74178bfc1eef Mon Sep 17 00:00:00 2001 From: John Gee Date: Mon, 2 Nov 2026 18:10:43 +1300 Subject: [PATCH] docs: add Release Policy --- README.md | 9 ++++++++- docs/release-policy.md | 13 +++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/release-policy.md diff --git a/README.md b/README.md index 3e02952a..a15584a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # cliui -![ci](https://github.com/yargs/cliui/workflows/ci/badge.svg) [![NPM version](https://img.shields.io/npm/v/cliui.svg)](https://www.npmjs.com/package/cliui) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) ![nycrc config on GitHub](https://img.shields.io/nycrc/yargs/cliui) @@ -159,3 +158,11 @@ a new line being created. Resets the UI elements of the current cliui instance, maintaining the values set for `width` and `wrap`. + +## Support + +The current version of `cliui` is fully supported on Long Term Support versions of Node.js, and requires at least v20. + +Older major versions of `cliui` receive security updates for 12 months. For more see: [Release Policy](./docs/release-policy.md). + +The main forum for free and community support is the project [Issues](https://github.com/yargs/cliui/issues) on GitHub. diff --git a/docs/release-policy.md b/docs/release-policy.md new file mode 100644 index 00000000..34ec602d --- /dev/null +++ b/docs/release-policy.md @@ -0,0 +1,13 @@ +# Release Policy + +We follow [Semantic Versioning](http://semver.org/spec/v2.0.0.html), and limit breaking changes to major versions. + +The release notes for major versions highlight breaking changes. The [changelog](../CHANGELOG.md) lists release notes for all versions. + +The current release line gets all updates: features, bug fixes, and security updates. Older maintenance versions get just security updates for 12 months. + +| Version | First Release | Release Note | Status | End of Life | +| ------- | ------------- | - | ------- | ----------- | +| 9.0.0 | 2025-03-16 | [9.0.0](https://github.com/yargs/cliui/releases/tag/v9.0.0) | current | - | +| 8.0.0 | 2021-11-16 | [8.0.0](https://github.com/yargs/cliui/releases/tag/v8.0.0) | end of life | 2026-03-16 | +| <8 | | | end of life | |