-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add dotnetup Version Intent & Timeline Doc
#55390
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nagilson
wants to merge
15
commits into
dotnet:release/dnup
Choose a base branch
from
nagilson:nagilson-dotnetup-support-policy
base: release/dnup
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+96
−0
Open
Changes from 13 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
7454a5a
Add prototype `dotnetup` support policy doc
nagilson b80a57d
Fix removed word
nagilson a26b61e
Mention how long `dotnetup` would receive support if it were deprecated
nagilson d77b861
Merge branch 'nagilson-dotnetup-support-policy' of https://github.com…
nagilson 4a08acc
Tighten verbage of support policy
nagilson f8d2d4f
mention daily builds may still receive breaking change notices
nagilson 39e910c
preview versions could be on a non preview .net
nagilson 2880a7e
Replace microsoft with .NET teams to clarify this is not a microsoft …
nagilson 5781d68
Clarify noun of ownership of support policy
nagilson a40d40a
mention preview versions are offered for public testing just like .ne…
nagilson 7311c8b
Clarify product timelines
nagilson 6608ef1
Move intent from being a support policy doc and more a version framin…
nagilson 95b7657
Merge branch 'release/dnup' into nagilson-dotnetup-support-policy
nagilson 2297edd
Fix grammatical error
nagilson c299a51
Address PR feedback: clarify title, dogfooding wording, and grammar f…
nagilson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # `dotnetup` `preview` vs `stable` Version Definitions | ||
|
|
||
| ## Overview | ||
|
|
||
| `dotnetup` refers exclusively to the standalone, self-contained tool for developers that helps them manage and acquire .NET. | ||
| `dotnetup` is a fast-moving CLI that is still changing and evolving. | ||
|
|
||
| Looking for the support policy for the .NET Platform? See the [.NET Support Policy](https://dotnet.microsoft.com/platform/support/policy) page. | ||
| `dotnetup`'s official support policy document is still underway; here, we aim to communicate version intent to allow users to pick which version of `dotnetup` to use. | ||
|
|
||
| Unlike the .NET SDK, `dotnetup` is a tip-only product. Only the most recently published `stable` version of `dotnetup` is supported. When a new `stable` version is published, it immediately supersedes the previous `stable` version. `daily` and `preview` versions are not supported. This policy may change as the product matures or when an official support policy page supersedes this document. | ||
|
|
||
| `dotnetup` is a standalone tool with a lifecycle that is independent of the .NET SDK lifecycle. | ||
|
|
||
| `dotnetup` releases in three channels: | ||
|
|
||
| - `daily` | ||
| - `preview` | ||
| - `stable` | ||
|
|
||
| Each channel's intent is outlined below. | ||
|
|
||
| ### Supported Platforms and Shells | ||
|
|
||
| The latest `stable` version of `dotnetup` is supported on Windows, macOS, and Linux versions supported by its embedded .NET Runtime. See the [.NET supported operating system policy](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md) for the applicable operating system lifecycle rules. | ||
|
|
||
| Shell integration, including profile modification and environment-script generation, is supported for Bash (`bash`), Z shell (`zsh`), fish (`fish`), and Windows PowerShell (`powershell`) alongside PowerShell Core (`pwsh`). Other shells are not yet supported for shell integration. | ||
|
|
||
| ### `Daily` Channel Versions | ||
|
|
||
| `daily` builds of `dotnetup` will be fresh out of `CI`, much like the `daily` or `nightly` builds of the .NET SDK. | ||
| We do not recommend using `daily` builds in production. They have no guarantees, no support, and are meant for our own engineering and testing. They are used at your own discretion. | ||
|
|
||
| The `daily` `dotnetup` builds will use themselves to build. This allows us to catch problems early by being a dogfooder of our own product. | ||
|
|
||
| Multiple `daily` builds may be published in one day. Only the most recent `daily` build is intended for dog food engineering use; older `daily` builds are not maintained. | ||
|
nagilson marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### Version Intent | ||
|
|
||
| The `daily` version of `dotnetup` does not have any guarantees. Features may be added, changed, or removed without notice. Breaking changes may be added without documentation or notice. We may implement backward compatibility for breaking changes even in `daily` builds; however, this is not an official policy and is at our discretion depending upon the feature and expected risk. | ||
|
|
||
| The `main` branch of the .NET SDK will also be a first party consumer of `dotnetup` `daily` builds. | ||
|
|
||
| If the `daily` build of `dotnetup` faces an issue, we do not guarantee any SLA or fix timeline. | ||
|
|
||
| ### `Preview` Channel Versions | ||
|
|
||
| At our discretion, `daily` builds may be promoted to `preview` versions. We will closely monitor telemetry for potential bugs or regressions added between the `preview` and `daily` build before promoting a `daily` to a `preview` build. `preview` versions are not officially supported but they are offered for public testing ahead of a promotion to a `stable` release. | ||
|
|
||
| The first `preview` version of `dotnetup` is targeted for release in `August 2026`. | ||
|
|
||
| `preview` versions may be built off the top of `preview` or `lts/sts` versions of .NET. | ||
|
|
||
| `preview` versions may contain breaking changes without notice. No service-level agreement or fix timeline applies to a `preview` version. Regardless, we aim to publish breaking change notices for expected high-impact changes. | ||
| .NET teams may use `preview` versions in its own build infrastructure. | ||
|
nagilson marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### `Stable` Channel Versions | ||
|
|
||
| Only the most recently published `stable` version of `dotnetup` is supported. Supported in this case means that `stable` versions receive security and bug fixes as patch versions. `daily` versions will eventually catch up with features added in `preview` versions. | ||
|
|
||
| The `stable` version of `dotnetup` will release in `November 2026` aligning around the .NET 11 timeframe. | ||
|
|
||
| `dotnetup` versioning is inspired by [Semantic Versioning](https://semver.org/) but does not strictly implement it. Major, minor, and patch version components communicate the expected scope of a release, but they are not compatibility guarantees; more detail is provided below. Intentional breaking changes will be documented regardless of which version component changes. In general, we will provide both notice and backward compatibility for breaking changes when within reason. | ||
|
|
||
| `stable` builds will be built off of `stable` .NET Runtimes. | ||
| The first runtime supporting a `stable` build will be `.NET 11`. | ||
|
|
||
| `stable` versions of `dotnetup` follow the [.NET Runtime servicing policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core#servicing). When a .NET Runtime servicing release updates the runtime embedded in `dotnetup`, the corresponding `dotnetup` release may be published up to three days later. The current `stable` version of `dotnetup` remains supported during this publication window. | ||
|
|
||
| #### Major `stable` Release | ||
|
|
||
| Major releases may include new features and functionality, new public APIs, bug fixes, and intentional [breaking changes](https://learn.microsoft.com/dotnet/core/compatibility/breaking-changes). | ||
|
|
||
| #### Minor `stable` Release | ||
|
|
||
| Minor releases may include new features, functionality, APIs, or bug fixes, but their scope will be generally smaller than that of major releases. | ||
|
|
||
| #### Patches & Servicing | ||
|
|
||
| Patch versions may include security fixes, bug fixes, and updates to the self-contained .NET Runtime embedded in the executable. A patch version is not intended to introduce new features. A patch update to the embedded runtime causes a patch update to `dotnetup`. | ||
|
|
||
| #### End of support | ||
|
|
||
| End of support refers to the date when Microsoft no longer provides fixes, updates, or online technical assistance for a product version. | ||
|
|
||
| When a new `stable` version of `dotnetup` is published, all previous versions immediately reach end of support. | ||
|
|
||
| At this time, historical `stable` versions of `dotnetup` will remain available for download as official [dotnet releases](https://builds.dotnet.microsoft.com/dotnet/release-metadata/releases-index.json) despite their lack of official support, much like historical .NET versions are available today. | ||
|
|
||
| PSAs and CVEs are planned to be announced under the [same platform (dotnet release notes)](https://github.com/dotnet/core) used for dotnet releases today, following a similar convention. However, discussions and release tags will exist on the [.NET SDK repository](https://github.com/dotnet/sdk). | ||
|
|
||
| ### FAQ | ||
|
|
||
| **How can I update to the latest `dotnetup` version?** | ||
|
|
||
| Once `stable` releases are available, follow the [download instructions](README.md#download-dotnetup) and select the `stable` build quality. Pass `--quality stable` to `get-dotnetup.sh` or `-Quality stable` to `get-dotnetup.ps1`. Running either script without this option currently installs a `daily` build, which are available today but not supported. | ||
|
nagilson marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.