Mark AzurePublisherOptions as Experimental#8240
Conversation
There was a problem hiding this comment.
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
a030d37 to
acc89da
Compare
|
|
||
| namespace Aspire.Hosting.Azure; | ||
|
|
||
| [Experimental("ASPIREAZURE001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")] |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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)
joperezr
left a comment
There was a problem hiding this comment.
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)
See #7811 (comment)
Checklist