Skip to content

Commit

Permalink
docs: add a RELEASE.md document and update the version support range …
Browse files Browse the repository at this point in the history
…in SECURITY.md (#272)

Signed-off-by: Shigure Kurosaki <[email protected]>
  • Loading branch information
kurosakishigure authored Jan 16, 2025
1 parent cc9d3aa commit 3cdbdda
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
7 changes: 6 additions & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

## Supported Versions

The [latest](https://github.com/kurosakishigure/katharsis/releases/latest) version of Katharsis on GitHub supports immediate security updates.
| Version | Supported | Description |
| --------------- | --------- | ------------------------- |
| ^1.0.0 | ✅ Yes | Latest stable release |
| ^1.0.0 (LTS) | ✅ Yes | Long-term support |
| ^1.0.0 (Canary) | ❌ No | Development purposes only |
| Older versions | ❌ No | Upgrade recommended |

## Reporting a Vulnerability

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,6 @@
- [API Docs](https://docs.rs/katharsis)
- [CONTRIBUTING.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/CONTRIBUTING.md)
- [SECURITY.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/SECURITY.md)
- [RELEASES.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/RELEASES.md)
- [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/LICENSES/NOTICE)
- [LICENSE](https://github.com/kurosakishigure/katharsis/blob/canary/LICENSE)
14 changes: 14 additions & 0 deletions docs/RELEASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Katharsis Releases

> [!NOTE]
> The version naming of Katharsis follows [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200).
## LTS

The previous MAJOR version of Katharsis is an [LTS](https://en.wikipedia.org/wiki/Long-term_support) version, offering six months of support.

## Release

| Version | Codename | Released at |
| ------- | -------- | ----------- |
| ^1.0.0 | - | - |

0 comments on commit 3cdbdda

Please sign in to comment.