Skip to content

docs: add releases EOL section #2700

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.

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

Merged
merged 2 commits into from
Aug 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
- [Shared configuration](#shared-configuration)
- [API](#api)
- [Tools](#tools)
- [Roadmap](#roadmap)
- [Version Support](#version-support)
- [Version Support and Releaes](#version-support-and-releaes)
- [Related projects](#related-projects)
- [License](#license)
- [Development](#development)
Expand Down Expand Up @@ -176,11 +175,27 @@ is room and need for improvement. The items on the roadmap should enhance `commi
- [ ] **DX**: Incorporate an extended version of [lennym/commit-template](https://github.com/lennym/commit-template) deducing a template from commitlint configuration
- [ ] **DX**: Rewrite `@commitlint/prompt` for better usability (might involve a lot of yak-shaving)

## Version Support
## Version Support and Releaes

- Node.js [LTS](https://github.com/nodejs/LTS#lts-schedule) `>= 12`
- git `>= 2.13.2`

### Releases

Security patches will be applied to versions which are not yet EOL.
Features will only be applied to the current main version.

| Release | Inital release | End-of-life |
| -------------------------------------------------------------------------------- | -------------- | ----------- |
| [v13](https://github.com/conventional-changelog/commitlint/releases/tag/v13.0.0) | 24.05.2021 | 24.05.2022 |
| [v12](https://github.com/conventional-changelog/commitlint/releases/tag/v12.0.0) | 23.02.2021 | 23.02.2022 |
| [v11](https://github.com/conventional-changelog/commitlint/releases/tag/v11.0.0) | 13.09.2020 | 13.09.2020 |

_Dates are subject to change._

We're not a sponsored OSS project. Therefor we can't promise that we will release patch versions for older releases in a timley manner.
If you are stuck on an older version and need a security patch we're happy if you can provide a PR.

## Related projects

- [conventional-changelog](https://git.io/v18sw) – Generate a changelog from conventional commit history
Expand Down
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- [Local setup](guides-local-setup.md)
- [CI setup](guides-ci-setup.md)
- [Use prompt](guides-use-prompt.md)
- [Releases](guides-releases.md)
- [Upgrade commitlint](guides-upgrade.md)

- **Concepts**
Expand Down
15 changes: 15 additions & 0 deletions docs/guides-releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Releases

Security patches will be applied to versions which are not yet EOL.
Features will only be applied to the current main version.

| Release | Inital release | End-of-life |
| -------------------------------------------------------------------------------- | -------------- | ----------- |
| [v13](https://github.com/conventional-changelog/commitlint/releases/tag/v13.0.0) | 24.05.2021 | 24.05.2022 |
| [v12](https://github.com/conventional-changelog/commitlint/releases/tag/v12.0.0) | 23.02.2021 | 23.02.2022 |
| [v11](https://github.com/conventional-changelog/commitlint/releases/tag/v11.0.0) | 13.09.2020 | 13.09.2020 |

_Dates are subject to change._

We're not a sponsored OSS project. Therefor we can't promise that we will release patch versions for older releases in a timley manner.
If you are stuck on an older version and need a security patch we're happy if you can provide a PR.