Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Oct 22, 2024

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

@joperezr joperezr requested a review from eerhardt October 22, 2024 22:37
@mitchdenny
Copy link
Member

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

@sebastienros
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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

@joperezr joperezr merged commit c51defd into release/9.0 Oct 23, 2024
9 checks passed
@joperezr joperezr deleted the backport/pr-6323-to-release/9.0 branch October 23, 2024 20:27
joperezr added a commit to joperezr/aspire that referenced this pull request Nov 13, 2024
#### AI description  (iteration 1)
#### PR Classification
Merge branch `release/9.0` into `internal/release/9.0` to integrate recent changes and address specific work items.

#### PR Summary
This pull request integrates changes from the `release/9.0` branch into `internal/release/9.0`, addressing several work items related to Azure storage and network isolation.
- `/tests/Aspire.Hosting.Azure.Tests/AzureContainerAppsTests.cs`: Added a new test `ConfigureCustomDomainsMutatesIngress` to validate custom domain configuration for Azure Container Apps.
- `/src/Aspire.Hosting.Azure.AppContainers/ContainerAppExtensions.cs`: Introduced a new extension method `ConfigureCustomDomain` to simplify the process of assigning custom domains to Azure Container Apps.

Related work items: dotnet#6368, dotnet#6391, dotnet#6433, dotnet#6458, dotnet#6467
@github-actions github-actions bot locked and limited conversation to collaborators Nov 23, 2024
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Mar 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants