dotnet / aspire

Tools, templates, and packages to accelerate building observable, production-ready apps
https://learn.microsoft.com/dotnet/aspire
MIT License
3.93k stars 480 forks source link

[release/9.0] Set docker summaries for all extensions. #6433

Closed github-actions[bot] closed 1 month ago

github-actions[bot] commented 1 month ago

Backport of #6323 to release/9.0

/cc @sebastienros

Customer Impact

Code documentation improvements.

Testing

Validated the tooltip shows the container image information:

image

Risk

None.

Regression?

No.

Microsoft Reviewers: Open in CodeFlow
mitchdenny commented 1 month ago

Is this going to work with a lot of these tags classes being internal?

sebastienros commented 1 month ago

Is this going to work with a lot of these tags classes being internal?

@mitchdenny

I tried from the playground project on Oracle, and AFAIK there is no InternalVisitbleTo on this one (see screenshot below)

image

And we can still see the docs. I will test with the packages though.

image

sebastienros commented 1 month ago

Verified with locally built packages:

image

And the .nupkg contains the xml docs file which seems to embed even the internal values (at least for the inherited ones)

<doc>
    <assembly>
        <name>Aspire.Hosting.Oracle</name>
    </assembly>
    <members>
        <member name="F:Aspire.Hosting.OracleContainerImageTags.Registry">
            <remarks>container-registry.oracle.com</remarks>
        </member>
        <member name="F:Aspire.Hosting.OracleContainerImageTags.Image">
            <remarks>database/free</remarks>
        </member>
        <member name="F:Aspire.Hosting.OracleContainerImageTags.Tag">
            <remarks>23.5.0.0</remarks>
        </member>
        <member name="T:Aspire.Hosting.OracleDatabaseBuilderExtensions">
            <summary>
            Provides extension methods for adding Oracle Database resources to an <see cref="T:Aspire.Hosting.IDistributedApplicationBuilder"/>.
            </summary>
        </member>
        <member name="M:Aspire.Hosting.OracleDatabaseBuilderExtensions.AddOracle(Aspire.Hosting.IDistributedApplicationBuilder,System.String,Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.ApplicationModel.ParameterResource},System.Nullable{System.Int32})">
            <summary>
            Adds a Oracle Server resource to the application model. A container is used for local development.
            </summary>
            <remarks>
            This version of the package defaults to the <inheritdoc cref="F:Aspire.Hosting.OracleContainerImageTags.Tag"/> tag of the <inheritdoc cref="F:Aspire.Hosting.OracleContainerImageTags.Registry"/>/<inheritdoc cref="F:Aspire.Hosting.OracleContainerImageTags.Image"/> container image.
joperezr commented 1 month ago

Low Risk (only changing comments), great value add for customers. Approved.