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

Mark AzurePublisherOptions as Experimental #8240

Merged
merged 1 commit into from
Mar 22, 2025

Conversation

eerhardt
Copy link
Member

See #7811 (comment)

Checklist

  • Is this feature complete?
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
  • Does the change make any security assumptions or guarantees?
    • No
  • Does the change require an update in our Aspire docs?

@github-actions github-actions bot added the area-integrations Issues pertaining to Aspire Integrations packages label Mar 21, 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 PR marks the AzurePublisherOptions API as experimental so that consumers are aware its interface and behavior may evolve.

  • Added an Experimental attribute to the AzurePublisherOptions class
  • Introduced a using directive for System.Diagnostics.CodeAnalysis

@@ -13,6 +14,7 @@

namespace Aspire.Hosting.Azure;

[Experimental("ASPIREAZURE001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
Copy link
Member

Choose a reason for hiding this comment

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

I know this is just following precedent of other experimental attributes, but in hindsight, I wonder if it would've been better to just have these attributes be all ASPIRE0xxx and just increment the number. That seems to be the pattern that some of the other repos using experimental do anyway.

Copy link
Member Author

@eerhardt eerhardt Mar 21, 2025

Choose a reason for hiding this comment

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

@mitchdenny - thoughts on this? I think you set the precedent as you were the first to make experimental APIs.

See Uses new Azure.Provisioning packages which have been split by resource (dotnet/aspire#3383)

9f499db

Copy link
Member

@joperezr joperezr left a comment

Choose a reason for hiding this comment

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

Separate from this PR, we should make sure that we are documenting these attributes and that the forward links work. (PS I see you added and linked a docs issue, my comment is just to do a pass for all of these)

@davidfowl davidfowl merged commit 15c98ab into dotnet:main Mar 22, 2025
163 checks passed
@eerhardt eerhardt deleted the ExperimentalPublisherOptions branch March 24, 2025 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-integrations Issues pertaining to Aspire Integrations packages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants