[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
1675 lines (1597 loc) · 41.4 KB

version-support.md

File metadata and controls

1675 lines (1597 loc) · 41.4 KB

+++ title = "Version Support" weight = 910 description = "A list of the support windows provided for language implementations." aliases = "/version-support/" type = "docs" +++

Support windows for protoc and the various languages are covered in the tables later in this topic. Version numbers throughout this topic use SemVer conventions; in the version "3.21.7," we say that "3" is the major version, "21" is the minor version, and "7" is the micro or patch number.

Starting with the v20.x protoc release, we changed our versioning scheme to enable nimbler updates to language-specific parts of Protocol Buffers. In the new scheme, each language has its own major version that can be incremented independently of other languages. The minor and patch versions, however, remain coupled. This allows us to introduce breaking changes into some languages without requiring a bump of the major version in languages that do not experience a breaking change. For example, a single release might include protoc version 24.0, Java runtime version 4.24.0 and C# runtime version 3.24.0.

The first instance of this new versioning scheme was the 4.21.0 version of the Python API, which followed the preceding version, 3.20.1. Other language APIs released at the same time were released as 3.21.0.

Release Cadence {#cadence}

Protobuf strives to release updates quarterly. We may add a release if there is an urgent need such as a security fix that requires new APIs. Skipping a release should be a very rare event.

Major (breaking) releases will be targeted to the Q1 release. We may introduce a major breaking change at any time if there is an urgent need, but this should be very rare.

Our support windows are defined by our library breaking change policy.

Protobuf does not consider enforcement of its documented language, tooling, platform, and library support policies to be a breaking change. For example, a release may drop support for an EOL language version without bumping major versions.

What Changes in a Release? {#changes}

The binary wire format does not change even in major version updates. You will continue to be able to read old binary wire format proto data from newer versions of Protocol Buffers. Newly generated protobuf bindings serialized to binary wire format will be parseable by older binaries. This is a fundamental design principle of Protocol Buffers. Note that JSON and textproto formats do not offer the same stability guarantees.

The descriptor.proto schema can change. In minor or patch releases, we may add new message, fields, enums, enum values, editions, editions features etc. We may also mark existing elements as deprecated. In a major release, we may remove deprecated options, enums, enum values, messages, fields, etc.

The .proto language grammar can change. In minor or patch releases, we may add new language constructs and alternative syntax for existing features. We may also mark certain features as deprecated. This could result in new warnings that were not previously emitted by protoc. In a major release, we may remove support for obsolete features, syntax, editions in a way that will require updates to client code.

Gencode and runtime APIs can change. In minor or patch releases, changes will either be purely additive for new functionality or source-compatible updates. Simply recompiling code should work. In a major release, the gencode or runtime API can change in incompatible ways that require callsite changes. We try to minimize these. Changes fixing or otherwise affecting undefined behavior are not considered breaking, and do not require a major release.

Operating system, programming language, and tooling version support can change. In a minor or patch release, we may add or drop support for particular versions of an operating system, programming language, or tooling. See foundational support matrices for our supported languages.

In general:

  • Minor or patch releases should only contain purely additive or source-compatible updates per our Cross Version Runtime Guarantee
  • Major releases may remove functionality, features, or change APIs in ways that require updates to callsites.

Support Duration {#duration}

The most recent release is always supported. Support for earlier minor versions ends when a new minor version under the same major version is released. Support for earlier major versions ends four quarters beyond the quarter that the breaking release is introduced. For example, when Python 4.21.0 was released in May of 2022, that set the end of public support of Python 3.20.1 at the end of 2023 Q2.

The following sections provide a guide to the support for each language.

C++ {#cpp}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
3.21.x 25 May 2022 31 Mar 2024
4.22.x 16 Feb 2023 8 May 2023
4.23.x 8 May 2023 8 Aug 2023
4.24.x 8 Aug 2023 1 Nov 2023
4.25.x 1 Nov 2023 31 Mar 2025
5.26.x 13 Mar 2024 23 May 2024
5.27.x 23 May 2024 28 Aug 2024
5.28.x 28 Aug 2024 TBD

This table graphically shows support durations.

C++ will target making major version bumps annually in Q1 of each year.

protoc C++ 23Q1 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
21.x 3.21.x PS PS PS PS SE
22.x 4.22.x IR
23.x 4.23.x IR
24.x 4.24.x IR
25.x 4.25.x IR PS PS PS PS SE
26.x 5.26.x IR
27.x 5.27.x IR
28.x 5.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x 5.29.x IR PS
30.x 6.30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

C++ Tooling, Platform, and Library Support {#cpp-tooling}

Protobuf is committed to following the tooling, platform, and library support policy described in Foundational C++ Support Policy. For specific versions supported, see Foundational C++ Support Matrix.

C# {#csharp}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
3.22.x 16 Feb 2023 8 May 2023
3.23.x 8 May 2023 8 Aug 2023
3.24.x 8 Aug 2023 1 Nov 2023
3.25.x 1 Nov 2023 13 Mar 2024
3.26.x 13 Mar 2024 23 May 2024
3.27.x 23 May 2024 28 Aug 2024
3.28.x 28 Aug 2024 TBD

This table graphically shows support durations.

protoc C# 23Q1 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
22.x 3.22.x IR
23.x 3.23.x IR
24.x 3.24.x IR
25.x 3.25.x IR
26.x 3.26.x IR
27.x 3.27.x IR
28.x 3.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x IR
30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

C# Platform and Library Support {#csharp-support}

Protobuf is committed to following the platform and library support policy described in .NET Support Policy. For specific versions supported, see Foundational .NET Support Matrix.

Java {#java}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
3.19.x 20 Oct 2021 25 Mar 2022
3.20.x 25 Mar 2022 25 May 2022
3.21.x 25 May 2022 16 Feb 2023
3.22.x 16 Feb 2023 8 May 2023
3.23.x 8 May 2023 8 Aug 2023
3.24.x 8 Aug 2023 1 Nov 2023
3.25.x 1 Nov 2023 31 Mar 2026*
4.26.x 13 Mar 2024 23 May 2024
4.27.x 23 May 2024 28 Aug 2024
4.28.x 28 Aug 2024 TBD

NOTE: The support window for the Java 3.25.x release will be 24 months rather than the typical 12 months for the final release in a major version line. Future major version updates (5.x+) will adopt an improved "rolling compatibility window" that should allow a return to 12-month support windows.

This table graphically shows support durations.

Java will target making major version bumps annually in Q1 of each year.

protoc Java 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
22.x 3.22.x
23.x 3.23.x IR
24.x 3.24.x IR
25.x 3.25.x IR PS PS PS PS PS
26.x 4.26.x IR
27.x 4.27.x IR
28.x 4.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x 4.29.x IR
30.x 4.30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

Java Platform and Library Support {#java-support}

Protobuf is committed to following the platform and library support policy described in Java Support Policy. For specific versions supported, see Foundational Java Support Matrix.

Objective-C {#objc}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
3.22.x 16 Feb 2023 8 May 2023
3.23.x 8 May 2023 8 Aug 2023
3.24.x 8 Aug 2023 1 Nov 2023
3.25.x 1 Nov 2023 13 Mar 2024
3.26.x 13 Mar 2024 23 May 2024
3.27.x 23 May 2024 28 Aug 2024
3.28.x 28 Aug 2024 TBD

This table graphically shows support durations.

protoc ObjC 23Q1 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
22.x 3.22.x IR
23.x 3.23.x IR
24.x 3.24.x IR
25.x 3.25.x IR
26.x 3.26.x IR
27.x 3.27.x IR
28.x 3.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x 3.29.x IR PS
30.x 4.30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

PHP {#php}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
3.22.x 16 Feb 2023 8 May 2023
3.23.x 8 May 2023 8 Aug 2023
3.24.x 8 Aug 2023 1 Nov 2023
3.25.x 1 Nov 2023 31 Mar 2025
4.26.x 13 Mar 2024 23 May 2024
4.27.x 23 May 2024 28 Aug 2024
4.28.x 28 Aug 2024 TBD

This table graphically shows support durations.

protoc PHP 23Q1 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
22.x 3.22.x IR
23.x 3.23.x IR
24.x 3.24.x IR
25.x 3.25.x IR PS PS PS PS SE
26.x 4.26.x IR
27.x 4.27.x IR
28.x 4.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x IR
30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

PHP Platform and Library Support {#php-support}

Protobuf is committed to following the platform and library support policy described in PHP Support Policy. For specific versions supported, see Foundational PHP Support Matrix.

Python {#python}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
4.22.x 16 Feb 2023 8 May 2023
4.23.x 8 May 2023 8 Aug 2023
4.24.x 8 Aug 2023 1 Nov 2023
4.25.x 1 Nov 2023 31 Mar 2025
5.26.x 13 Mar 2024 23 May 2024
5.27.x 23 May 2024 28 Aug 2024
5.28.x 28 Aug 2024 TBD

This table graphically shows support durations.

protoc Python 23Q1 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
22.x 4.22.x IR
23.x 4.23.x IR
24.x 4.24.x IR
25.x 4.25.x IR PS PS PS PS SE
26.x 5.26.x IR
27.x 5.27.x IR
28.x 5.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x 5.29.x IR PS
30.x 6.30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

Python Platform and Library Support {#python-support}

Protobuf is committed to following the platform and library support policy described in Python Support Policy. For specific versions supported, see Foundational Python Support Matrix.

Ruby {#ruby}

This table provides specific dates for support duration.

Branch Initial Release Public Support Until
3.21.x 25 May 2022 16 Feb 2023
3.22.x 16 Feb 2023 8 May 2023
3.23.x 8 May 2023 8 Aug 2023
3.24.x 8 Aug 2023 1 Nov 2023
3.25.x 1 Nov 2023 31 Mar 2025
4.26.x 13 Mar 2024 23 May 2024
4.27.x 23 May 2024 28 Aug 2024
4.28.x 28 Aug 2024 TBD

This table graphically shows support durations.

protoc Ruby 23Q1 23Q2 23Q3 23Q4 24Q1 24Q2 24Q3 24Q4 25Q1
22.x 3.22.x IR
23.x 3.23.x IR
24.x 3.24.x IR
25.x 3.25.x IR PS PS PS PS SE
26.x 4.26.x IR
27.x 4.27.x IR
28.x 4.28.x IR
The cells below are projections of future releases, but are not guarantees
that those releases will happen, or that they will happen on that schedule.
29.x IR
30.x IR
Legend
Initial release (IR)
Public support (PS)
Support ends (SE)

Ruby Platform and Library Support {#ruby-support}

Protobuf is committed to following the platform and library support policy described in Ruby Support Policy. For specific versions supported, see Foundational Ruby Support Matrix.

JRuby is not officially supported, but we provide unofficial support for the latest JRuby version targeting compatibility with our minimum Ruby version or above on a best-effort basis.