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.

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 experimental attribute and suppress warnings #8378

Merged
merged 5 commits into from
Mar 29, 2025

Conversation

mitchdenny
Copy link
Member

Introduce an experimental attribute for publisher methods and disable related warnings in playground and tests to streamline development and evaluation.

Fixes: #8304

@Copilot Copilot bot review requested due to automatic review settings March 28, 2025 12:41
@mitchdenny mitchdenny self-assigned this Mar 28, 2025
@github-actions github-actions bot added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label Mar 28, 2025
@mitchdenny mitchdenny added area-deployment and removed area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication labels Mar 28, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request introduces a new experimental attribute ("ASPIREPUBLISHERS001") for publisher methods and updates the warning suppression across tests and playground applications to streamline development and evaluation.

  • Replaces the old experimental identifier in Azure publisher extensions with the new "ASPIREPUBLISHERS001".
  • Adds the experimental attribute to publisher extension methods in multiple projects.
  • Updates test and playground files to disable the new warning and removes now-unneeded suppressions for the deprecated identifier.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/Aspire.Hosting.Tests/Backchannel/AppHostBackchannelTests.cs Disables the new experimental warning for test evaluations.
tests/Aspire.Hosting.Docker.Tests/DockerComposePublisherTests.cs Suppresses experimental warnings for Docker publisher tests.
src/Aspire.Hosting/PublisherDistributedApplicationBuilderExtensions.cs Applies the experimental attribute to the generic AddPublisher method.
src/Aspire.Hosting.Kubernetes/KubernetesPublisherExtensions.cs Applies the experimental attribute to both Kubernetes publisher overloads.
src/Aspire.Hosting.Docker/DockerComposePublisherExtensions.cs Applies the experimental attribute to both Docker Compose publisher overloads.
src/Aspire.Hosting.Azure/AzurePublisherExtensions.cs Updates the experimental attribute from the old ASPIREAZURE001 to ASPIREPUBLISHERS001.
playground/publishers/Publishers.AppHost/Program.cs Adds warning suppression for the new identifier and removes deprecated suppression for Azure.
Comments suppressed due to low confidence (2)

playground/publishers/Publishers.AppHost/Program.cs:17

  • The removal of warning suppression for ASPIREAZURE001 indicates that AzurePublisher warnings are now expected to be handled by the new experimental attribute; please confirm that this change is intended and update related documentation if necessary.
builder.AddAzurePublisher("azure");

src/Aspire.Hosting.Azure/AzurePublisherExtensions.cs:19

  • [nitpick] Ensure that the experimental attribute identifier 'ASPIREPUBLISHERS001' is consistently documented and used throughout the codebase to avoid confusion with the previous identifier.
[Experimental("ASPIREPUBLISHERS001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]

@mitchdenny mitchdenny added this to the 9.2 milestone Mar 28, 2025
@mitchdenny mitchdenny requested a review from davidfowl March 28, 2025 12:41
@davidfowl
Copy link
Member

We don’t need it for compose as that’s prerelease

@mitchdenny mitchdenny merged commit 4b14555 into main Mar 29, 2025
172 checks passed
@mitchdenny mitchdenny deleted the mitchdenny/publishers-experimental branch March 29, 2025 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add [Experimental] attributes to incoming APIs that support publishing.
2 participants