Skip to content

Commit 5a9020f

Browse files
Merge pull request Mbed-TLS#8941 from daverodgman/branches-3.6lts
Update BRANCHES for 3.6
2 parents 32a96d6 + 0da8c51 commit 5a9020f

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

BRANCHES.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,32 @@
22

33
At any point in time, we have a number of maintained branches, currently consisting of:
44

5-
- The [`master`](https://github.com/Mbed-TLS/mbedtls/tree/master) branch:
5+
- The [`main`](https://github.com/Mbed-TLS/mbedtls/tree/main) branch:
66
this always contains the latest release, including all publicly available
77
security fixes.
88
- 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,
1111
as well as all the new features and bug fixes and security fixes.
1212
- 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).
1516

1617
We retain a number of historical branches, whose names are prefixed by `archive/`,
1718
such as [`archive/mbedtls-2.7`](https://github.com/Mbed-TLS/mbedtls/tree/archive/mbedtls-2.7).
1819
These branches will not receive any changes or updates.
1920

2021
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.
2223
the API of 3.(x+1) is backward compatible with 3.x). We only break API
2324
compatibility on major version changes (e.g. from 3.x to 4.0). We also maintain
2425
ABI compatibility within LTS branches; see the next section for details.
2526

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.
3031

3132
## Backwards Compatibility for application code
3233

@@ -102,10 +103,13 @@ CONTRIBUTING](CONTRIBUTING.md#backwards-compatibility).
102103

103104
The following branches are currently maintained:
104105

105-
- [master](https://github.com/Mbed-TLS/mbedtls/tree/master)
106+
- [main](https://github.com/Mbed-TLS/mbedtls/tree/main)
106107
- [`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>.
107111
- [`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>.
110114

111115
Users are urged to always use the latest version of a maintained branch.

BUGS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Known issues in Mbed TLS are [tracked on GitHub](https://github.com/Mbed-TLS/mbe
77
If you think you've found a bug in Mbed TLS, please follow these steps:
88

99
1. Make sure you're using the latest version of a
10-
[maintained branch](BRANCHES.md): `master`, `development`,
10+
[maintained branch](BRANCHES.md): `main`, `development`,
1111
or a long-time support branch.
1212
2. Check [GitHub](https://github.com/Mbed-TLS/mbedtls/issues) to see if
1313
your issue has already been reported. If not, …

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ For machines with a Unix shell and OpenSSL (and optionally GnuTLS) installed, ad
250250
- `tests/scripts/depends.py` test builds in configurations with a single curve, key exchange, hash, cipher, or pkalg on.
251251
- `tests/scripts/all.sh` runs a combination of the above tests, plus some more, with various build options (such as ASan, full `mbedtls_config.h`, etc).
252252
253-
Instead of manually installing the required versions of all tools required for testing, it is possible to use the Docker images from our CI systems, as explained in [our testing infrastructure repository](https://github.com/Mbed-TLS/mbedtls-test/blob/master/README.md#quick-start).
253+
Instead of manually installing the required versions of all tools required for testing, it is possible to use the Docker images from our CI systems, as explained in [our testing infrastructure repository](https://github.com/Mbed-TLS/mbedtls-test/blob/main/README.md#quick-start).
254254
255255
Porting Mbed TLS
256256
----------------

0 commit comments

Comments
 (0)