You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This pull request refactors and improves the logic for generating README tag listing tables in the image builder. The main changes include moving the McrTagsMetadataGenerator to a new namespace, simplifying and restructuring the code for generating markdown tables from MCR tags metadata, and introducing extension methods for repo name parsing. These updates make the codebase more modular, readable, and easier to maintain, while also enhancing the clarity of the generated documentation.
Refactoring and Code Organization:
Moved McrTagsMetadataGenerator to the new namespace Microsoft.DotNet.ImageBuilder.Mcr, updating all relevant imports across the codebase. [1][2][3][4]
Markdown Table Generation Improvements:
Refactored the tags listing logic in GenerateReadmesCommand to group tag metadata by OS and architecture, and to generate markdown tables with improved structure and readability. The new approach uses the TagsTable record for organizing tables and supports nested sub-tables for custom tag groups.
Extension Methods for Repo Name Parsing:
Replaced static helper methods with extension methods GetParentRepoName and GetShortName for parsing hierarchical repo names, improving code clarity and reuse.
Documentation and Comments:
Added detailed XML documentation comments to key methods and records in GenerateReadmesCommand, clarifying their responsibilities and usage. [1][2][3]
Code Simplification and Cleanup:
Removed legacy table header constants and outdated helper classes, consolidating table formatting logic into the new markdown generation flow. [1][2]
Thanks for working on this! The order in the tags table is slightly different than I was expecting and feels inconsistent with Linux. Is that an artifact of running these changes with the current sdk-tags.yml metadata template? I was expecting all 10.0 tags to be listed then 9.0, etc. I was expecting the sort order should be .NET version desc, OS variant asc, OS version desc.
Thanks for working on this! The order in the tags table is slightly different than I was expecting and feels inconsistent with Linux. Is that an artifact of running these changes with the current sdk-tags.yml metadata template? I was expecting all 10.0 tags to be listed then 9.0, etc. I was expecting the sort order should be .NET version desc, OS variant asc, OS version desc.
@MichaelSimons Yes. We control the sorting in the dotnet-docker repo. We can re-order them any way we'd like from the mcr-tags-metadata files. I agree that sorting by .NET and then by OS makes more sense and is more consistent with Linux tags tables.
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.
Fixes #1593.
Before/After
Example from
dotnet/dotnet-docker/nightly>README.runtime.md:Before
Nano Server 2025 amd64 Tags
.NET 11 Preview Tags
Windows Server Core 2025 amd64 Tags
.NET 11 Preview Tags
Nano Server 2022 amd64 Tags
Windows Server Core 2022 amd64 Tags
Nano Server, version 1809 amd64 Tags
Windows Server Core 2019 amd64 Tags
After
Windows amd64 Tags
.NET 11 Preview Tags
AI-generated summary:
This pull request refactors and improves the logic for generating README tag listing tables in the image builder. The main changes include moving the
McrTagsMetadataGeneratorto a new namespace, simplifying and restructuring the code for generating markdown tables from MCR tags metadata, and introducing extension methods for repo name parsing. These updates make the codebase more modular, readable, and easier to maintain, while also enhancing the clarity of the generated documentation.Refactoring and Code Organization:
McrTagsMetadataGeneratorto the new namespaceMicrosoft.DotNet.ImageBuilder.Mcr, updating all relevant imports across the codebase. [1] [2] [3] [4]Markdown Table Generation Improvements:
GenerateReadmesCommandto group tag metadata by OS and architecture, and to generate markdown tables with improved structure and readability. The new approach uses theTagsTablerecord for organizing tables and supports nested sub-tables for custom tag groups.Extension Methods for Repo Name Parsing:
GetParentRepoNameandGetShortNamefor parsing hierarchical repo names, improving code clarity and reuse.Documentation and Comments:
GenerateReadmesCommand, clarifying their responsibilities and usage. [1] [2] [3]Code Simplification and Cleanup: