Skip to content
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.

Sign up for GitHub

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

Add .NET major version release checklist #5034

Merged
merged 4 commits into from
Dec 7, 2023
Merged

Add .NET major version release checklist #5034

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05bb4b4
Add new major version checklist
lbussell Dec 1, 2023
0608e7c
Updates based on code review
lbussell Dec 5, 2023
543b7bc
Address code review
lbussell Dec 6, 2023
f8e2bf0
Update EOL wording
lbussell Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/releases/dotnet-major-version-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# New .NET Major Version Release

.NET version being released:

This issue is intended to stay open for the entire support duration of the above major .NET version.
lbussell marked this conversation as resolved.
Show resolved Hide resolved

### Breaking changes
- For each breaking change made throughout development, file a new issue using the ".NET breaking change" template in the [dotnet/docs repo](https://github.com/dotnet/docs/issues/new/choose).
- List any breaking change issues created below:

## Alpha
- [ ] Add new .NET version images to `nightly` branch
- Create new images
- Add entries for the new .NET versions in `manifest.versions.json`
lbussell marked this conversation as resolved.
Show resolved Hide resolved
- Add new images for the new .NET version in each repo in `manifest.json`
- Adjust existing templates or add new templates in `eng/dockerfile-templates/` if necessary
- If there are no major changes between .NET versions, the new images can share `runtime-deps` layers with the previous .NET version
- Include only the latest/LTS version of each operating system according to our [supported operating systems documentation](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md#operating-systems).
- If adding a new OS version, follow the guidelines in [new-distro-release.md](https://raw.githubusercontent.com/dotnet/dotnet-docker/main/.github/ISSUE_TEMPLATE/releases/new-distro-release.md)
- If PowerShell is not yet supported or functional on the new .NET version, file an issue at [PowerShell/PowerShell](https://github.com/PowerShell/PowerShell/issues) or link to an existing issue, exclude PowerShell from the new SDK images, and [file an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) to re-enable PowerShell in .NET Docker images
- Update tests
- Add new version info to [ImageVersion.cs](https://github.com/dotnet/dotnet-docker/blob/nightly/tests/Microsoft.DotNet.Docker.Tests/ImageVersion.cs)
- Update the [test data](https://github.com/dotnet/dotnet-docker/blob/nightly/tests/Microsoft.DotNet.Docker.Tests/TestData.cs) to include the new distro version
- If various tests are not yet functional on the new .NET version, file issues on product team repos as necessary, disable the test with a link to the issue, and file an issue in the dotnet/dotnet-docker repo to re-enable the test
- Update readmes
- Update the [MCR tags metadata templates](https://github.com/dotnet/dotnet-docker/tree/main/eng/mcr-tags-metadata-templates) to include the new distro version
- The new tags should be in a preview sub-table, like so: https://github.com/dotnet/dotnet-docker/blob/8fc28db4f706d81a1fd075f2c6b2ca514ae75c84/eng/mcr-tags-metadata-templates/aspnet-tags.yml#L1-L3
- Update image size baselines
- Add new placeholder entries to the image size baselines in [tests/performance/](https://github.com/dotnet/dotnet-docker/blob/nightly/tests/performance)
lbussell marked this conversation as resolved.
Show resolved Hide resolved
- Queue a build of the [dotnet-docker-nightly](https://dev.azure.com/dnceng/internal/_build?definitionId=359) pipeline targeting only the new images, for example with the variable: `imagebuilder.pathArgs: --path '*9.0*'`
lbussell marked this conversation as resolved.
Show resolved Hide resolved
- Inspect the image sizes by pulling the new images from the `dotnetdockerdev` ACR and update the baselines accordingly
lbussell marked this conversation as resolved.
Show resolved Hide resolved
- Move `latest` tags to the new .NET version

## Preview 1
- [ ] Merge new .NET version images from `nightly` branch to `main`

## RC1
lbussell marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Update Featured Tags in main branch
- [ ] Move new version tags out of preview sub-tables in readmes
lbussell marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Move .NET Docker projects to the new .NET version's TFM
- Example issue: https://github.com/dotnet/docker-tools/issues/1181
- [ ] Update samples to new .NET version
- Consider creating new samples to feature new .NET or .NET Docker features

## GA
- [ ] Move `latest` tags in `manifest.json` to the new version
- Relevant issue: https://github.com/dotnet/dotnet-docker/issues/2316
- [ ] Add the new .NET version to the .NET Framework SDK image
- https://github.com/microsoft/dotnet-framework-docker/blob/6a3c9d048f75c1e69c0e1059564cd56a90bf9e3c/eng/dockerfile-templates/sdk/Dockerfile#L56-L59
- [ ] Post a new announcement on the [GitHub Discussions page](https://github.com/dotnet/dotnet-docker/discussions/new?category=announcements) page and pin the announcement
- Include new .NET Docker features and breaking changes and defer to other official .NET documentation/announcements for other features
- Example announcement: https://github.com/dotnet/dotnet-docker/discussions/4995
- [ ] If the new version is an LTS version,

## EOL
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not expecting this given the title. Should this be in a separate doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine with this going in a separate doc. It's pretty unlikely that we would forget when a major .NET version goes EOL, but I do see value in tracking the date on the board either way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, I don't think EOL belongs in a separate doc. I don't see value in that. This is already a long-lived checklist covering alpha to GA so including EOL is just part of the overall lifecycle. The title of the doc could be changed to ".NET Version Lifecyle Checklist" or something.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that's the case, this needs rewording File all issues at once when a new .NET version is in Alpha.. IMO we shouldn't be opening an EOL issue until the EOL is known and closer to the EOL date. The presence of this issue sooner could cause confusion.

- [ ] Remove all entries for the EOL .NET version in `manifest.json`, `manifest.versions.json`, [ImageVersion.cs](https://github.com/dotnet/dotnet-docker/blob/nightly/tests/Microsoft.DotNet.Docker.Tests/ImageVersion.cs), [TestData.cs](https://github.com/dotnet/dotnet-docker/blob/nightly/tests/Microsoft.DotNet.Docker.Tests/TestData.cs), [MCR tags metadata templates](https://github.com/dotnet/dotnet-docker/tree/main/eng/mcr-tags-metadata-templates), and delete the Dockerfiles
- [ ] Search for and simplify conditions including the EOL .NET Version in the Dockerfile templates and tests
- [ ] Replace all references to the EOL .NET version in documentation with a new .NET version
- [ ] Remove the EOL .NET version from the .NET Framework SDK images
- https://github.com/microsoft/dotnet-framework-docker/blob/6a3c9d048f75c1e69c0e1059564cd56a90bf9e3c/eng/dockerfile-templates/sdk/Dockerfile#L56-L59
- [ ] Post a new announcement on the [GitHub Discussions page](https://github.com/dotnet/dotnet-docker/discussions/new?category=announcements)
0 ...ISSUE_TEMPLATE/releases/dotnet-release.md → ...SUE_TEMPLATE/releases/dotnet-servicing.md
View file
Open in desktop
File renamed without changes.