You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The CI pipeline can check that all snippets are used to make sure people don't accidentally forget to use any they defined (and also makes sure any referenced are defined), but the default is turned off currently. Many SDKs have already opted in to do this check during the Analyze job, but I think we should enable that by default.
Running eng/scripts/Update-Snippets.ps1 * -StrictMode, I find the following SDKs still have some unreferenced snippets:
communication
dns
formrecognizer
iot
servicebus
We should make sure that a new instance of a DPG template does not run afoul of this error as well, but given the command above didn't find any issues it should be fine. We should create an instance though and double check.
Client library authors should run Update-Snippets.ps1 {ServiceDirectory} to check compliance, and to make sure any README or sample markdowns are properly updated (which the Analyze step will also do or fail).
The text was updated successfully, but these errors were encountered:
heaths
added
Client
This issue points to a problem in the data-plane of the library.
EngSys
This issue is impacting the engineering system.
labels
Feb 3, 2023
for an example. We should also go through and get rid of such lines so just so it's more obvious we check snippets by default and isn't something you need to opt into.
I would be a fan of turning this on by default. Today I have to manually check these things (didn't know about the opt in flag) and its easy to miss them.
* Build snippets during Analyze job by default
Resolves#33877
* Resolve PR feedback
* Don't build snippets for Core
Core has a few issues actually compiling with SNIPPET symbol because it
tries to elide some code for brevity. Fixing that changes the extracted
snippets and may make the samples more confusing so leaving as-is.
The CI pipeline can check that all snippets are used to make sure people don't accidentally forget to use any they defined (and also makes sure any referenced are defined), but the default is turned off currently. Many SDKs have already opted in to do this check during the Analyze job, but I think we should enable that by default.
Running
eng/scripts/Update-Snippets.ps1 * -StrictMode
, I find the following SDKs still have some unreferenced snippets:We should make sure that a new instance of a DPG template does not run afoul of this error as well, but given the command above didn't find any issues it should be fine. We should create an instance though and double check.
Client library authors should run
Update-Snippets.ps1 {ServiceDirectory}
to check compliance, and to make sure any README or sample markdowns are properly updated (which the Analyze step will also do or fail).Also see related snippet clean-up issue #20431
The text was updated successfully, but these errors were encountered: