Azure / azure-sdk-for-net

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
MIT License
5.26k stars 4.61k forks source link

Update Snippet replacement syntax #20431

Closed pakrym closed 5 months ago

pakrym commented 3 years ago

We are switching from the //@@ and /*@@*/ syntax for line replacement in snippets to a more C#-native #if SNIPPET .. #endif preprocessor directive.

Please switch your samples to use the new syntax. Example migration: https://github.com/Azure/azure-sdk-for-net/pull/20391/files#diff-988626950b27d8a9a30cfe0d394aba056f460eeadfd350f5f8e7b894f63c6c0d

Before:

 /*@@*/string workspaceId = TestEnvironment.WorkspaceId;
 //@@string workspaceId = "<workspace_id>";

After:

#if SNIPPET
            string workspaceId = "<workspace_id>";
#else
            string workspaceId = TestEnvironment.WorkspaceId;
#endif

🍏 appconfiguration

Owners: @annelo-msft @AlexanderSher

Files:

sdk/appconfiguration/Azure.Data.AppConfiguration/tests/samples/Sample10_SecretReference.cs
sdk/appconfiguration/Azure.Data.AppConfiguration/tests/samples/SampleSnippets.cs

attestation

Owners: @anilba06

Files:

sdk/attestation/Azure.Security.Attestation/tests/Samples/AttestationServiceAttestationSamples.cs

communication

Owners: @acsdevx-msft

Files:

sdk/communication/Azure.Communication.Chat/tests/samples/Sample2_MessagingOperations.cs
sdk/communication/Azure.Communication.Chat/tests/samples/Sample4_KeyConcepts.cs
sdk/communication/Azure.Communication.Common/tests/Identity/CommunicationTokenCredentialTest.cs
sdk/communication/Azure.Communication.Identity/tests/samples/Sample1_CommunicationIdentityClient.cs
sdk/communication/Azure.Communication.PhoneNumbers/tests/samples/Sample_PhoneNumbersClient.cs
sdk/communication/Azure.Communication.Sms/tests/SmsClientLiveTestBase.cs
sdk/communication/Azure.Communication.Sms/tests/SmsClientLiveTests.cs
sdk/communication/Azure.Communication.Sms/tests/samples/Sample1_SmsClient.cs

🍏 core

Owners: @pakrym @KrzysztofCwalina

Files:

sdk/core/Azure.Core/tests/AzureNamedKeyCredentialTests.cs
sdk/core/Microsoft.Azure.Core.NewtonsoftJson/tests/Samples/Readme.cs
sdk/core/Microsoft.Azure.Core.Spatial.NewtonsoftJson/tests/Samples/Readme.cs
sdk/core/Microsoft.Azure.Core.Spatial/tests/Samples/Readme.cs

eventhub

Owners: @serkantkaraca @jsquire

Files:

sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/MigrationGuideSnippetsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/ReadMeSnippetsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample01_HelloWorldLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample02_EventProcessorConfigurationLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample03_EventProcessorHandlersLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample04_ProcessingEventsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample05_IdentityAndSharedAccessCredentialsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample06_RequestingStorageServiceVersionsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Core/EventHubsConnectionStringPropertiesTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/MigrationGuideSnippetsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/ReadMeSnippetsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/Sample02_EventHubsClientsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/Sample03_EventHubMetadataLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/Sample04_PublishingEventsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/Sample05_ReadingEventsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/Sample06_IdentityAndSharedAccessCredentialsLiveTests.cs
sdk/eventhub/Azure.Messaging.EventHubs/tests/Snippets/Sample07_EarlierLanguageVersionsLiveTests.cs
sdk/eventhub/Microsoft.Azure.EventHubs/tests/Snippets/MigrationGuideSnippets.cs

🍏 formrecognizer

Owners: @annelo-msft @kinelski @maririos

Files:

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample11_ComposedModel.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample12_RecognizeBusinessCardsFromFile.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample12_RecognizeBusinessCardsFromUri.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample13_RecognizeInvoicesFromFile.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample13_RecognizeInvoicesFromUri.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample15_RecognizeIdDocumentsFromFile.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample15_RecognizeIdDocumentsFromUri.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample1_RecognizeContentFromFile.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample1_RecognizeContentFromUri.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample2_RecognizeCustomFormsFromFile.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample2_RecognizeCustomFormsFromUri.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample3_RecognizeReceiptsFromFile.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample3_RecognizeReceiptsFromUri.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample4_StronglyTypingARecognizedForm.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample5_TrainModelWithForms.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample6_TrainModelWithFormsAndLabels.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample7_ManageCustomModels.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample7_ManageCustomModelsAsync.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample8_CopyModel.cs
sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/SampleSnippets.cs

🍏 keyvault

Owners: @schaabs @heaths

Files:

sdk/keyvault/Azure.Security.KeyVault.Administration/tests/samples/AccessControlSampleSnippets.cs
sdk/keyvault/Azure.Security.KeyVault.Administration/tests/samples/Sample1_BackupHelloWorld.cs
sdk/keyvault/Azure.Security.KeyVault.Administration/tests/samples/Sample1_RbacHelloWorld.cs
sdk/keyvault/Azure.Security.KeyVault.Administration/tests/samples/Sample2_RbacScopeAssignment.cs
sdk/keyvault/Azure.Security.KeyVault.Administration/tests/samples/Sample2_SelectiveRestore.cs
sdk/keyvault/Azure.Security.KeyVault.Administration/tests/samples/Sample3_BackRestoreResume.cs
sdk/keyvault/Azure.Security.KeyVault.Certificates/tests/CertificateClientLiveTests.cs
sdk/keyvault/Azure.Security.KeyVault.Certificates/tests/samples/Sample3_ImportCertificate.cs
sdk/keyvault/Azure.Security.KeyVault.Certificates/tests/samples/Sample3_ImportCertificateAsync.cs
sdk/keyvault/Azure.Security.KeyVault.Certificates/tests/samples/SampleSnippets.cs
sdk/keyvault/Azure.Security.KeyVault.Keys/tests/samples/Sample3_GetKeys.cs
sdk/keyvault/Azure.Security.KeyVault.Keys/tests/samples/Sample3_GetKeysAsync.cs
sdk/keyvault/Azure.Security.KeyVault.Keys/tests/samples/SampleSnippets.cs
sdk/keyvault/Azure.Security.KeyVault.Secrets/tests/samples/Sample3_GetSecrets.cs
sdk/keyvault/Azure.Security.KeyVault.Secrets/tests/samples/Sample3_GetSecretsAsync.cs
sdk/keyvault/Azure.Security.KeyVault.Secrets/tests/samples/SampleSnippets.cs
sdk/keyvault/Microsoft.Azure.KeyVault/tests/SampleSnippets.cs

🍏 metricsadvisor

Owners: @kinelski

Files:

sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Sample01_DataFeedCrudOperations.cs
sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Sample02_DataFeedIngestionOperations.cs
sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Sample03_DetectionConfigurationCrudOperations.cs
sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Sample05_AlertConfigurationCrudOperations.cs
sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Sample06_QueryTriggeredAlerts.cs
sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Sample07_QueryDetectedAnomalies.cs
sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/Samples/Snippets.cs

monitor

Owners: @SameergMS @dadunl

Files:

sdk/monitor/Azure.Monitory.Query/tests/LogsClientSamples.cs

🍏 search

Owners: @brjohnstmsft @arv100kri @bleroy @Mohit-Chakraborty @tg-msft @heaths

Files:

sdk/search/Azure.Search.Documents/tests/Samples/Readme.cs
sdk/search/Azure.Search.Documents/tests/Samples/Sample01_HelloWorld.cs
sdk/search/Azure.Search.Documents/tests/Samples/Sample04_FieldBuilderIgnore.cs
sdk/search/Azure.Search.Documents/tests/Samples/Sample05_IndexingDocuments.cs
sdk/search/Azure.Search.Documents/tests/Samples/Sample06_EncryptedIndex.cs

servicebus

Owners: @JoshLove-msft @jsquire

Files:

sdk/servicebus/Azure.Messaging.ServiceBus/tests/Primitives/ServiceBusConnectionStringPropertiesTests.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample01_HelloWorld.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample02_MessageSettlement.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample03_SendReceiveSessions.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample04_Processor.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample05_SessionProcessor.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample06_Transactions.cs
sdk/servicebus/Azure.Messaging.ServiceBus/tests/Samples/Sample07_CrudOperations.cs

storage

Owners: @tg-msft @amishra-dev @seanmcc-msft @amnguye @kasobol-msft

Files:

sdk/storage/Azure.Storage.Blobs.Batch/samples/Sample03a_Batching.cs
sdk/storage/Azure.Storage.Blobs/samples/Sample01a_HelloWorld.cs
sdk/storage/Azure.Storage.Blobs/samples/Sample01b_HelloWorldAsync.cs
sdk/storage/Azure.Storage.Files.Shares/samples/Sample01a_HelloWorld.cs
sdk/storage/Azure.Storage.Files.Shares/samples/Sample01b_HelloWorldAsync.cs
sdk/storage/Azure.Storage.Queues/samples/Sample01a_HelloWorld.cs
sdk/storage/Azure.Storage.Queues/samples/Sample01b_HelloWorldAsync.cs

synapse

Owners: @aim-for-better @idear1203 @chamons

Files:

sdk/synapse/Azure.Analytics.Synapse.AccessControl/tests/samples/Sample1_HelloWorld.cs
sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample1_HelloWorldPipeline.cs
sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample2_HelloWorldNotebook.cs
sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample3_HelloWorldTrigger.cs
sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample4_HelloWorldDataFlow.cs
sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample5_HelloWorldDataset.cs
sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample6_HelloWorldLinkedService.cs
sdk/synapse/Azure.Analytics.Synapse.ManagedPrivateEndpoints/tests/samples/Sample1_HelloManangedPrivateEndpoint.cs
sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample1_SubmitSparkJob.cs
sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample1_SubmitSparkJobAsync.cs
sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample2_ExecuteSparkStatement.cs
sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample2_ExecuteSparkStatementAsync.cs

🍏 tables

Owners: @christothes

Files:

sdk/tables/Azure.Data.Tables/tests/samples/Sample1_CreateDeleteTable.cs
sdk/tables/Azure.Data.Tables/tests/samples/Sample6_TransactionalBatchAsync.cs

🍏 textanalytics

Owners: @annelo-msft @maririos @suhas92

Files:

sdk/textanalytics/Azure.AI.TextAnalytics.Protocol/tests/snippets/JsonDataSnippets.cs
sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/SampleSnippets.cs

🍏 translation

Owners: @maririos

Files:

sdk/translation/Azure.AI.Translation.Document/tests/samples/SampleSnippets.cs
sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_MultipleInputs.cs
sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_MultipleInputsAsync.cs
sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_PollIndividualDocuments.cs
sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_PollIndividualDocumentsAsync.cs
sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_StartTranslation.cs
sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_StartTranslationAsync.cs
heaths commented 3 years ago

There should be no markdown changes, though for KV and Search this exercise yielded a couple bugs so I ended up with 3 desirable markdown changes.

pakrym commented 2 years ago

We are almost there, only

synapse communication eventhub attestation

left.

heaths commented 1 year ago

Running the following script, I still find the following client libraries are using this older syntax:

$found = dir sdk | dir -include Azure.* | dir -filter *.cs -recurse | select-string '(//@@|/\*@@\*/)'
$found | group @{e={$relpath = $_.relativepath($PWD); $relpath.Substring(4, $relpath.indexof('\', 4) - 4) }} -NoElement | sort count -desc

I'll update the OP to make use of "new" task lists to track these.

github-actions[bot] commented 6 months ago

Hi @pakrym, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

pallavit commented 6 months ago

@kinelski can we remove the older syntax?

github-actions[bot] commented 5 months ago

Hi @pakrym, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.