Skip to content

Commit 8e706bd

Browse files
committed
Add supported versions policy doc (4.0+)
- Document major support window, security fix line, and go-live scope - Link from README; wiki remains source for the release matrix Made-with: Cursor
1 parent c4c6820 commit 8e706bd

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ In addition to the [feature documentation](https://steeltoe.io/api), we have bui
3636
| 3.x (Integration, Messaging and Stream) | .NET Core 3.1 - .NET 6 |
3737
| 2.x | .NET Framework 4.6.1+ |
3838

39-
For more details, see [Supported Versions on the Wiki](https://github.com/SteeltoeOSS/Steeltoe/wiki/Steeltoe-Support-Versions).
39+
For the support policy, see [Supported versions](docs/Steeltoe-Support-Versions.md). For the full page with the release support matrix, see [Supported versions on the Wiki](https://github.com/SteeltoeOSS/Steeltoe/wiki/Steeltoe-Support-Versions).
4040

4141
## Support and Feedback
4242

docs/Steeltoe-Support-Versions.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Steeltoe supported versions
2+
3+
The [release support matrix](https://github.com/SteeltoeOSS/Steeltoe/wiki/Steeltoe-Support-Versions#release-support-matrix) (dates, .NET runtimes) is on the project wiki. This page explains the support **policy** in the repository so it can be reviewed with pull requests.
4+
5+
## Policy for Steeltoe 4.0 and newer
6+
7+
**Scope.** The rules in this section apply to **Steeltoe 4.0 and later**. They do not change the dates already published for **3.x and older** in the wiki table. For those older lines, use the table as written.
8+
9+
**Support policy**
10+
11+
Steeltoe is *informed by* the VMware Tanzu open source support policy. The rules in this section are the Steeltoe project rules. They apply to **Steeltoe 4.0 and newer**.
12+
13+
- **How long is a major supported?** A **major** is supported for **at least three years** from the **date that major was released**. It is also supported for **at least one year** after the **date the next major is released**. Support ends on the **later** of these two dates.
14+
- **Where do fixes go?** **Security** fixes and fixes for **serious** bugs are provided only in **new patch** releases of the **newest** **minor** in a supported **major** (for example, only 4.2.x if 4.2 is the newest minor, not 4.0.x or 4.1.x). You need the **latest patch** of that **newest** minor. We do **not** add new **security** patches to **older** minors. **Upgrade** to the newest **minor** and the **latest patch** to get those fixes.
15+
16+
**Go-live releases**
17+
18+
Go-live releases are supported by the Steeltoe team in production. These are typically our release candidate builds, just before the generally available (GA) release.
19+
20+
Pre-GA and go-live packages are not in scope for the same security patch policy unless explicitly announced.
21+
22+
**Released versions**
23+
24+
For **4.0 and newer**, use the **newest** **minor** in your **major** and the **latest patch** to get **security** fixes (see **Support policy** above). The wiki table is unchanged for older versions: follow the **Scope** note above.
25+
26+
**Matrix note (4.0+)**
27+
28+
End of support for a **major** is no **earlier** than: (1) **three years** after that major’s first release, or (2) **one year** after the next major releases—**whichever date is later**. The dates in the wiki table for **3.x and older** are not changed by this policy.
29+
30+
**Release compatibility**
31+
32+
**Security** fixes and fixes for **serious** bugs do not go to every **minor** in a **major** at the same time. For **4.0 and newer**, use the **newest** **minor** and the **latest patch** (see **Support policy** above). Moving up between **minors** should still be in line with our **compatibility** goals within a **major** (see the [Release compatibility](https://github.com/SteeltoeOSS/Steeltoe/wiki/Steeltoe-Support-Versions#release-compatibility) section on the wiki).
33+
34+
### .NET runtime support
35+
36+
Steeltoe depends on .NET runtimes. Follow the [.NET and .NET Core support policy](https://dotnet.microsoft.com/platform/support/policy). More detail is in the **.NET Runtime Support** section on the [wiki page](https://github.com/SteeltoeOSS/Steeltoe/wiki/Steeltoe-Support-Versions#net-runtime-support).

0 commit comments

Comments
 (0)