[storage] Migrate storage projects to use snippets extraction #33271
+4,590
−1,528
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
mpodwysocki
requested review from
EmmaZhu,
XiaoningLiu,
vinjiang,
jiacfan,
ljian3377 and
blueww
as code owners
There was a problem hiding this comment.
PR Overview
This PR migrates the storage projects to use snippets extraction for code samples in tests, READMEs, and Migration Guides. Key changes include updating sample code blocks to use TypeScript snippet markers, updating various client README files to reference snippets, and inserting dev-tool ignore markers in changelogs and migration guides.
Reviewed Changes
| File | Description |
|---|---|
| sdk/storage/storage-blob-changefeed/test/snippets.spec.ts | Added TypeScript sample tests using snippet extraction markers. |
| sdk/storage/storage-blob-changefeed/README.md | Updated code sample blocks to reference TS snippets. |
| sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts | Updated inline code samples to use TS snippet markers. |
| sdk/storage/storage-blob/src/BlobBatchClient.ts | Updated sample comments to include TS snippet markers. |
| sdk/storage/storage-blob/src/ContainerClient.ts | Updated code snippets to use TS snippet markers and improved examples. |
| sdk/storage/storage-blob/src/BlobServiceClient.ts | Revised sample code blocks, switching from JS to TS snippet markers. |
| sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts | Updated snippet examples for customer usage of change feed listing. |
| sdk/storage/storage-file-datalake/src/clients.ts | Updated Node.js and browser sample code blocks with TS snippet markers. |
| Various README.md and CHANGELOG.md files | Inserted snippet markers and dev-tool ignore comments for consistent documentation. |
| MigrationGuide.md files (storage-blob, storage-file-share) | Added dev-tool snippet ignore markers and updated credential instantiations. |
Copilot reviewed 37 out of 37 changed files in this pull request and generated no comments.
|
API change check API changes are not detected in this pull request. |
EmmaZhu
reviewed
Mar 12, 2025
| @@ -49,7 +49,7 @@ | |||
| "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"", | |||
| "integration-test": "npm run integration-test:node && npm run integration-test:browser", | |||
| "integration-test:browser": "karma start --single-run", | |||
| "integration-test:node": "dev-tool run test:node-js-input --no-test-proxy -- -t 300000 \"dist-esm/test/*.spec.js\" \"dist-esm/test/node/*.spec.js\"", | |||
| "integration-test:node": "dev-tool run test:node-js-input --no-test-proxy -- --exclude 'test/snippets.spec.ts' -t 300000 \"dist-esm/test/*.spec.js\" \"dist-esm/test/node/*.spec.js\"", | |||
There was a problem hiding this comment.
Seams this would cause test fail.
storage-internal-avro is not a project, it's just a folder to place some codes for storage-blob-changefeed, we should not test it as a project.
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.
Packages impacted by this PR
Issues associated with this PR
Describe the problem that is addressed by this PR
Updates all projects under
databoxedgeto use snippets extraction.What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
Provide a list of related PRs (if any)
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Checklists