|
2 | 2 |
|
3 | 3 | At any point in time, we have a number of maintained branches, currently consisting of:
|
4 | 4 |
|
5 |
| -- The [`master`](https://github.com/Mbed-TLS/mbedtls/tree/master) branch: |
| 5 | +- The [`main`](https://github.com/Mbed-TLS/mbedtls/tree/main) branch: |
6 | 6 | this always contains the latest release, including all publicly available
|
7 | 7 | security fixes.
|
8 | 8 | - The [`development`](https://github.com/Mbed-TLS/mbedtls/tree/development) branch:
|
9 |
| - this is where the current major version of Mbed TLS (version 3.x) is being |
10 |
| - prepared. It has API changes that make it incompatible with Mbed TLS 2.x, |
| 9 | + this is where the next major version of Mbed TLS (version 4.0) is being |
| 10 | + prepared. It has API changes that make it incompatible with Mbed TLS 3.x, |
11 | 11 | as well as all the new features and bug fixes and security fixes.
|
12 | 12 | - One or more long-time support (LTS) branches: these only get bug fixes and
|
13 |
| - security fixes. Currently, the only supported LTS branch is: |
14 |
| - [`mbedtls-2.28`](https://github.com/Mbed-TLS/mbedtls/tree/mbedtls-2.28). |
| 13 | + security fixes. Currently, the supported LTS branches are: |
| 14 | +- [`mbedtls-2.28`](https://github.com/Mbed-TLS/mbedtls/tree/mbedtls-2.28). |
| 15 | +- [`mbedtls-3.6`](https://github.com/Mbed-TLS/mbedtls/tree/mbedtls-3.6). |
15 | 16 |
|
16 | 17 | We retain a number of historical branches, whose names are prefixed by `archive/`,
|
17 | 18 | such as [`archive/mbedtls-2.7`](https://github.com/Mbed-TLS/mbedtls/tree/archive/mbedtls-2.7).
|
18 | 19 | These branches will not receive any changes or updates.
|
19 | 20 |
|
20 | 21 | We use [Semantic Versioning](https://semver.org/). In particular, we maintain
|
21 |
| -API compatibility in the `master` branch across minor version changes (e.g. |
| 22 | +API compatibility in the `main` branch across minor version changes (e.g. |
22 | 23 | the API of 3.(x+1) is backward compatible with 3.x). We only break API
|
23 | 24 | compatibility on major version changes (e.g. from 3.x to 4.0). We also maintain
|
24 | 25 | ABI compatibility within LTS branches; see the next section for details.
|
25 | 26 |
|
26 |
| -Every major version will become an LTS branch when the next major version is |
27 |
| -released. We may occasionally create LTS branches from other releases at our |
28 |
| -discretion. |
29 |
| -When a new LTS branch is created, it usually remains supported for three years. |
| 27 | +We will make regular LTS releases on an 18-month cycle, each of which will have |
| 28 | +a 3 year support lifetime. On this basis, 3.6 LTS (released March 2024) will be |
| 29 | +supported until March 2027. The next LTS release will be a 4.x release, which is |
| 30 | +planned for September 2025. |
30 | 31 |
|
31 | 32 | ## Backwards Compatibility for application code
|
32 | 33 |
|
@@ -102,10 +103,13 @@ CONTRIBUTING](CONTRIBUTING.md#backwards-compatibility).
|
102 | 103 |
|
103 | 104 | The following branches are currently maintained:
|
104 | 105 |
|
105 |
| -- [master](https://github.com/Mbed-TLS/mbedtls/tree/master) |
| 106 | +- [main](https://github.com/Mbed-TLS/mbedtls/tree/main) |
106 | 107 | - [`development`](https://github.com/Mbed-TLS/mbedtls/)
|
| 108 | +- [`mbedtls-3.6`](https://github.com/Mbed-TLS/mbedtls/tree/mbedtls-3.6) |
| 109 | + maintained until March 2027, see |
| 110 | + <https://github.com/Mbed-TLS/mbedtls/releases/tag/v3.6.0>. |
107 | 111 | - [`mbedtls-2.28`](https://github.com/Mbed-TLS/mbedtls/tree/mbedtls-2.28)
|
108 |
| - maintained until at least the end of 2024, see |
109 |
| - <https://github.com/Mbed-TLS/mbedtls/releases/tag/v2.28.7>. |
| 112 | + maintained until the end of 2024, see |
| 113 | + <https://github.com/Mbed-TLS/mbedtls/releases/tag/v2.28.8>. |
110 | 114 |
|
111 | 115 | Users are urged to always use the latest version of a maintained branch.
|
0 commit comments