Skip to content

docs: add Release Policy #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shadowspawn wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add Release Policy #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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.
13 changes: 13 additions & 0 deletions docs/release-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 | |
Loading