Skip to content

Commit

Permalink
Clean up Release.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@nibanks
nibanks committed Jan 17, 2021
1 parent 66ed26a commit 8d595dc
Showing 1 changed file with 32 additions and 29 deletions.
61 changes: 32 additions & 29 deletions docs/Release.md
View file
Original file line number Diff line number Diff line change
@@ -1,41 +1,18 @@
# Support for MsQuic

An MsQuic release begins its life in the main branch where it receives feature updates as well as servicing for security and bug fixes. When it is time to release, the code will be forked into a release branch where it is considered stable and will only receive servicing for security and bug fixes.

## MsQuic Releases

MsQuic releases will correspond to Windows releases. A release branch will be created (forked) for each Windows release. The release branch will be created at the same time as in Windows: when we hit stabilization. Then, the release will be finalized some time before Windows GAs. Once finalized the release branch will only be serviced with security and bug fixes throughout its lifecycle, which will end at the same time as the Windows release support ends.

This table describes the version, release date and end of support for MsQuic releases.

| Version | Fork Date | Release Date | Support Type | End of Support |
| -- | -- | -- | -- | -- |
| 1.0 | Nov 13 2020 | TBD | TBD | TBD |

\* Future release dates are subject to change.

### MsQuic v1.0

MsQuic v1.0 is the first officially supported release. The primary shipping vehicle for this release will be the [Windows Server vNext](https://techcommunity.microsoft.com/t5/windows-server-insiders/announcing-windows-server-vnext-preview-build-19551/m-p/1133432) (actual name TBD) release. No official, signed binaries are currently slated to be released. Linux support is considered a preview for this release.

As the QUIC specifications are currently in IETF last call, only the latest draft version(s) numbers are supported initially, and not the official "version 1". If the specs aren't RFC status by the release date, then the release will be serviced (updated) accordingly when they do reach RFC.

> **Important** QUIC protocol features not fully implemented:
>
> * 0-RTT
> * Client-side Migration
> * Server Preferred Address
> * Path MTU Discovery
An MsQuic release begins its life in the main branch where it receives feature updates as well as servicing for security and bug fixes. When it is time to release, the code will be forked into a release branch where it is considered stable and will generally only receive servicing for security and bug fixes.

## MsQuic Branches

MsQuic has two types of branches **main** and **release** defined as:
MsQuic has two main types of branches **main** and **release** defined as:

* **Main** - Main is the primary development branch, and receives security and bug fixes just the same as the release branches. However, the main branch is where active development happens and because of this the main branch may experience breaking changes as we develop new features.

* **Release** - Release branches only receive security and bug fixes, and are considered stable. There should be no breaking changes in these branches, and they can be used for stable products.

\* Both types of branch receive critical fixes throughout their lifecycle, for security, reliability.
* **Prerelease** - Only release branches explicitly indicated below, in the **Official Releases** section, are considered officially supported and serviced releases. All others are considered prereleases, which are considered stable, but will not receive servicing fixes.

\* Both main and official release branches receive critical fixes throughout their lifecycle, for security, reliability.

## Release Support Policies

Expand All @@ -45,6 +22,32 @@ MsQuic support lifecycle is governed by the Windows Server servicing channels: [
* **SAC** release branches will be serviced for 18 months.
* **Main** is not considered supported branch because it is under active development. It does however receive security and bug fixes.

### End of support
## End of support

End of support refers to the date when Microsoft no longer provides fixes, updates, or online technical assistance for your product. As this date nears, make sure you have the latest available update installed. Without Microsoft support, you will no longer receive security updates that can help protect your machine from harmful viruses, spyware, and other malicious software that can steal your personal information.

# Official Releases

A release branch will be created (forked) for each official release of MsQuic. The release branch will then go through a several month stabilization process before it is then finalized as an official release. Once finalized the release branch will only be serviced with security and bug fixes throughout its lifecycle. MsQuic official releases generally will correspond to Windows releases, but in some cases additional future releases may be created for other major products. Releases for Windows generally will end support at the same time as the Windows release.

This table describes the version, release date and end of support for official (non-prerelease) MsQuic releases.

| Release | Branch | Fork Date | Release Date | Support Type | End of Support |
| -- | -- | -- | -- | -- | -- |
| [1.0](https://github.com/microsoft/msquic/releases/tag/v1.0.0-129524) | [release/1.0](https://github.com/microsoft/msquic/tree/release/1.0) | Nov 13 2020 | Jan 5 2020 | LTSC | Jan 4 2025 (2030) |

<br>\* Future **Release Dates** are subject to change.
<br>\** **End of Support** dates in parentheses are for [extended support](https://docs.microsoft.com/en-us/windows-server/get-started-19/servicing-channels-19#long-term-servicing-channel-ltsc).

## MsQuic v1.0

[MsQuic v1.0](https://github.com/microsoft/msquic/releases/tag/v1.0.0-129524) is the first officially supported release. The primary shipping vehicle for this release will be the [Windows Server vNext](https://techcommunity.microsoft.com/t5/windows-server-insiders/announcing-windows-server-preview-build-20282/m-p/2061907) release. No official, signed binaries are currently slated to be released. Linux support is considered a preview for this release.

The QUIC specifications are currently "Submitted to IESG for Publication", so both the v1 and draft-29 versions are supported by this release.

> **Important** QUIC protocol features not fully implemented:
>
> * 0-RTT
> * Client-side Migration
> * Server Preferred Address
> * Path MTU Discovery

0 comments on commit 8d595dc

Please sign in to comment.