[dev-tool] Enable sample folders to use nested directory structures. #15110
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
witemple-msft
requested review from
sarangan12,
maorleger,
deyaaeldeen and
joheredi
witemple-msft
requested review from
mikeharder and
praveenkuttappan
as code owners
maorleger
approved these changes
May 3, 2021
| // We also need to clean up extra blank lines that might be left behind by | ||
| // removing azsdk tags. These regular expressions are extremely frustrating | ||
| // because they deal almost exclusively in the literal "/" and "*" characters. | ||
| .replace(/(\s+\*)+\//s, EOL + " */") |
There was a problem hiding this comment.
We should add some tests for this logic, otherwise future me will definitely break it accidentally😄
openapi-sdkautomation bot
pushed a commit
to AzureSDKAutomation/azure-sdk-for-js
that referenced
this pull request
Aug 26, 2021
Mitryakh/network march (Azure#15709) * Adds base for updating Microsoft.Network from version stable/2021-02-01 to version 2021-03-01 * Updates readme * Updates API version in new specs and examples * Add new parameter to enable/disable BGP route translation for NAT VirtualWan VpnGateway (Azure#14462) * Adding Bastion Host Configuration Features (Azure#14442) Co-authored-by: Abhishek Shah <shabhis@microsoft.com> * Add PL ASG (Azure#14620) * Add PL ASG * Prettier * [Private Link] Private Endpoint Ipconfigurations swagger for 2021-03-01 (Azure#14662) * Ipconfigurations swagger * Ran prettier check * fixing conflicting files * fixing lint * Fixing linter diff * Lint diff * resolving comments * fixing conflict * Fioxing * running prettier * Fixing linter comment Co-authored-by: Shane Baden <shbaden@microsoft.com> * Add missing properties of ServiceEndpointPolicy (Azure#14948) * Add missing 'type' and 'serviceAlias' for ServiceEndpointPolicy related API response * Add missing 'contextualServiceEndpointPolicies' * fix bug * fix type * Add missing properties to ServiceEndpointPolicy * Revert "fix type" This reverts commit 3a49beb66d9bbb288fa0d3baaeaf5aaf2bbc6ee9. * Revert "fix bug" This reverts commit a4fff4ae925b01ed0cfb07b1594fb95e2c6649c7. * Revert "Add missing 'contextualServiceEndpointPolicies'" This reverts commit ccf19167abc61b90bce6b5204dc3b2a64fdf4ca4. * Revert "Add missing 'type' and 'serviceAlias' for ServiceEndpointPolicy related API response" This reverts commit e532cc1118241a74902e4362c32c25c11a764933. Co-authored-by: Xu Wang <wax@microsoft.com> * add new service tag details api (Azure#14958) * add new service tag details api * prettier check fixes * fixing lint issue, additional properties issue * Add Load distribution policy and global configuration to AppGW (Azure#14790) * add Load distribution policy and global configuration to Application Gateway resource * prettify * remove provisioning state * add public ssh key to network virtual appliance (Azure#14988) * Changes needed for BgpEndpoint (Azure#14800) * changes needed for BgpEndpoint * prettier check * model validation fix * fix description * update again * Multi QoS support for DSCP configuration (Azure#15120) * Updating the DSCP jsons to reflect the multi-qos support * Adding support to multi-qos * adding the type object to NrpQos * fixing the prettier removing my update to the settings * fixing the missing type object error. seeing if this also fixes the additional attributes exception * fixing the prettier exception * almost forgot this, it was refactor from NrpQos to QosDefinition. NRPQos is already being used in Networking repo * copying what I did with my other objects * names didn't match with what I have in NRP's src * forgot to update the examples with the updates in the specification. updating it * fixing the merge exceptions * Add SQL Setting to Firewall Policy (Azure#15110) * Add SQL Setting to Firewall Policy * fix lint check except for object type * resolve linter error * network: fix newly added targets field to an array and missing sub-resource properties in applicationGateways.json (Azure#15318) * fix: change target to an array and add subresource properties * fix target examples * Support to update tags for BastionHost resource (Azure#15446) * Initial commit * Validation fixes * Update bastionHost.json Co-authored-by: Abhishek Shah <shabhis@microsoft.com> * Azure FW - Explicit Proxy feature swagger change (Azure#15017) * explicit proxy swagger change * prettier check fix * lint check * prettier fix * revert unnecessary file change * Add kind to virtual hub (Azure#15562) * Adding customnetworkinterfacename attribute to Private Endpoint (Azure#15574) Co-authored-by: Shane Baden <shbaden@microsoft.com> * Added 3 new properties to InboundNatRule resource (Azure#15611) * Added the missins properties to fix the change breaking update (Azure#15732) Co-authored-by: Nilambari <nilamd@microsoft.com> Co-authored-by: Abhishek Shah <shah.abhi7860@gmail.com> Co-authored-by: Abhishek Shah <shabhis@microsoft.com> Co-authored-by: Yang Shi <yangshi93@gmail.com> Co-authored-by: Shane Baden <naruto.shane@gmail.com> Co-authored-by: Shane Baden <shbaden@microsoft.com> Co-authored-by: Xu Wang <wangxu724@gmail.com> Co-authored-by: Xu Wang <wax@microsoft.com> Co-authored-by: guptas14 <71726901+guptas14@users.noreply.github.com> Co-authored-by: Akshay Gupta <aksgupta@microsoft.com> Co-authored-by: litchiyangMSFT <64560090+litchiyangMSFT@users.noreply.github.com> Co-authored-by: Ritvika Reddy Nagula <rinagula@microsoft.com> Co-authored-by: David Velasco <davelasc@microsoft.com> Co-authored-by: Jiejiong Wu <b564518128@users.noreply.github.com> Co-authored-by: tinawu6 <78238424+tinawu6@users.noreply.github.com> Co-authored-by: irrogozh <irrogozh@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some samples have nested directory structures. For example, service bus has an
advancedfolder, and cognitive search has many subfolders. This PR teaches dev-tool to handle these nested sample directory structures correctly.In addition, it introduces another
azsdkJSDoc tag:@azsdk-util, which indicates that a sample should be omitted from the sample index in the README files. This is useful for utility modules that we still want to copy into the sample output directory, but don't want to be added to the list of sample files in the READMEs. Simply add@azsdk-utilor@azsdk-util trueto a JSDoc comment at the top of the file (per a great suggestion from @maorleger, the handler for@azsdktags now assumes that if a tag is specified with no value, that is the same as the valuetrue, which is similar to how boolean HTML attributes work).As a result, a file within
samples-devMUST have one of@summaryor@azsdk-util. The only case in which@summaryis allowed to be missing is if@azsdk-utilis specified.I also added some logic to clean up empty JSDoc comments, since it may be the case that
may be the only contents of the first JSDoc comment, and we wouldn't want the left-over empty comment to be published.
--
I tested this PR for backwards compatibility by regenerating all samples and observed no obvious changes related to this pull request.