-
Notifications
You must be signed in to change notification settings - Fork 138
Add Guidelines for Platforms Tested in CI #3726
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8eb834a
Add Guidelines for Platforms Tested in CI
MichaelSimons be4caac
Apply suggestions from code review
MichaelSimons cb2fc3d
Misc edits
MichaelSimons acd8914
Update Documentation/ci-platform-coverage-guidelines.md
MichaelSimons f91ecd7
'supported' clarity
MichaelSimons be947e1
Merge branch 'main' into ci-policy
MichaelSimons 9d9158a
Add clarity on distro versions
MichaelSimons 8f71f8a
Update Documentation/ci-platform-coverage-guidelines.md
MichaelSimons 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,45 @@ | ||
| # Guidelines for Platforms Tested in CI | ||
|
|
||
| This document contains the guidelines for which platforms (OS and architectures) to test in | ||
| the source build CI. | ||
|
|
||
| ## Distro Families | ||
|
|
||
| 1. Prefer testing base distros of families over derivatives. | ||
| 1. Prioritize testing distros that source build .NET. | ||
| 1. Use CentOS Stream instead of Red Hat because it is the free alternative. | ||
| 1. Include a permutation of distros for the supported C standard library implementations | ||
| (e.g. glibc and musl). | ||
| 1. Only test [distros that are officially supported by .NET](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md#net-supported-os-policy). | ||
| Community supported distros will not be covered. | ||
|
|
||
| **Note:** There will be conflicts within these guidelines. When they occur, it is an indication | ||
| that multiple legs will be needed. For example, Ubuntu is based on Debian. However, .NET is included | ||
| in Ubuntu's repositories by default but not Debian's (at the time of writing). As such, it is best | ||
| to include legs for both Ubuntu and Debian. | ||
|
|
||
| ## Distro Versions | ||
|
|
||
| When selecting which distro versions to test the .NET version in development, it is important to take into account which distro versions will be in support at the time of the .NET release. Don't worry about testing .NET on distro versions that will be or nearing EOL on the .NET release day. | ||
|
|
||
| 1. Latest LTS version. If the distro doesn't have an LTS notion, then test latest. | ||
| 1. Oldest version that will be in-support for the lifetime of the .NET release. | ||
|
|
||
| ## Architectures | ||
|
|
||
| 1. Amd64 | ||
| 1. Arm64 | ||
|
|
||
| ## Permutations | ||
|
|
||
| It is not the intent to test every permutation of distro family, distro version, and architecture. | ||
| Rather, smart decisions should be made to utilize resources. For example, test the oldest LTS version | ||
| of Debian on amd64 and the latest LTS version of Ubuntu on arm64. | ||
|
|
||
| 1. CentOS Stream | ||
| 1. Newest in support version | ||
| 1. Oldest in support version (for the lifetime of .NET) | ||
| 1. Fedora - Newest in support version | ||
| 1. Debian - Oldest LTS version (for the lifetime of .NET) | ||
| 1. Ubuntu - Newest LTS version (arm64) | ||
| 1. Alpine - Newest in support version |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I missed committing this change in my last doc update so I am including it here.