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
This PR fixes several inconsistencies found while reviewing all markdown files in the documentation/ folder against the current source code and repository structure.
Typo fix: clientSecrat → clientSecret in the ClientSecretCredential code example (line 44). This was a misspelling that would confuse developers copying the snippet.
documentation/golden-testing-commands.md
Stale script name: npm run unit-test:node → npm run test:node. The unit-test:node script no longer exists in SDK packages — the standard script is test:node (as confirmed by checking sdk/core/core-rest-pipeline/package.json and other packages).
documentation/writing-performance-tests.md
Incorrect path pattern: The document instructed developers to create perf test packages at sdk/<service>/perf-tests/<service-sdk>, but the actual convention used across the repository is sdk/<service>/<service-sdk>-perf-tests (e.g., sdk/storage/storage-blob-perf-tests, sdk/storage/storage-file-datalake-perf-tests, sdk/core/core-rest-pipeline-perf-tests). All path references updated to match the real convention.
Missing file warning: The common/tools/perf-tests-track-1-setup.js script referenced in the track-1 section does not exist in the repository. Added a note alerting readers that this is a legacy reference and to contact the SDK team for guidance.
Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
pkgs.dev.azure.com
To allow these domains, add them to the network.allowed list in your workflow frontmatter:
This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
The changes have been pushed to branch docs/fix-documentation-inconsistencies-928a3acf0f83b11f.
To fix the permissions issue, go to Settings → Actions → General and enable Allow GitHub Actions to create and approve pull requests. See also: gh-aw FAQ
Show patch preview (101 of 101 lines)
From d84cfebbeb38264340e2779e142d7116a5837794 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 25 May 2026 09:06:53 +0000
Subject: [PATCH] docs: fix inconsistencies in documentation
- Fix typo 'clientSecrat' -> 'clientSecret' in MIGRATION guide- Fix stale script name 'unit-test:node' -> 'test:node' in golden-testing-commands.md- Fix incorrect perf test path pattern 'sdk/<service>/perf-tests/<service-sdk>'
to match actual repo convention 'sdk/<service>/<service-sdk>-perf-tests'
- Add note that common/tools/perf-tests-track-1-setup.js no longer exists
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
...e-for-next-generation-management-libraries.md | 2 +-
documentation/golden-testing-commands.md | 2 +-
documentation/writing-performance-tests.md | 16 +++++++++-------
3 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/documentation/MIGRATION-guide-for-next-generation-management-libraries.md b/documentation/MIGRATION-guide-for-next-generation-management-libraries.md
index ebbaad258..ce01452f6 100644
--- a/documentation/MIGRATION-guide-for-next-generation-management-libraries.md+++ b/documentation/MIGRATION-guide-for-next-generation-management-libraries.md@@ -41,7 +41,7 @@ into
```typescript
import { ClientSecretCredential } from "@azure/identity";
-const credentials = new ClientSecretCredential(tenantId, clientId, clientSecrat);+const credentials = new ClientSecretCredential(tenantId, clientId, clientSecret);
This PR fixes several inconsistencies found while reviewing all markdown files in the
documentation/folder against the current source code and repository structure.Changes
documentation/MIGRATION-guide-for-next-generation-management-libraries.mdclientSecrat→clientSecretin theClientSecretCredentialcode example (line 44). This was a misspelling that would confuse developers copying the snippet.documentation/golden-testing-commands.mdnpm run unit-test:node→npm run test:node. Theunit-test:nodescript no longer exists in SDK packages — the standard script istest:node(as confirmed by checkingsdk/core/core-rest-pipeline/package.jsonand other packages).documentation/writing-performance-tests.mdsdk/<service>/perf-tests/<service-sdk>, but the actual convention used across the repository issdk/<service>/<service-sdk>-perf-tests(e.g.,sdk/storage/storage-blob-perf-tests,sdk/storage/storage-file-datalake-perf-tests,sdk/core/core-rest-pipeline-perf-tests). All path references updated to match the real convention.common/tools/perf-tests-track-1-setup.jsscript referenced in the track-1 section does not exist in the repository. Added a note alerting readers that this is a legacy reference and to contact the SDK team for guidance.Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
pkgs.dev.azure.comSee Network Configuration for more information.
Note
This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
The changes have been pushed to branch
docs/fix-documentation-inconsistencies-928a3acf0f83b11f.Click here to create the pull request
To fix the permissions issue, go to Settings → Actions → General and enable Allow GitHub Actions to create and approve pull requests. See also: gh-aw FAQ
Show patch preview (101 of 101 lines)
Please refer to @azure/identity for more details about
@azure/identityand migration guide from @azure/ms-rest-nodeauth to @azure/identity on how to migrate from@azure/ms-rest-nodeauth.diff --git a/documentation/golden-testing-commands.md b/documentation/golden-testing-commands.md
index f746d
... (truncated)