diff --git a/.vscode/cspell.json b/.vscode/cspell.json index e275304761f30..404d6e1621bc8 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -26,7 +26,29 @@ "*.log", "*.sln", "*.user", - ".vscode/cspell.json" + ".vscode/cspell.json", + + // These services are opted out of public API surface spell checking. + // Spelling issues must be addressed before adding these back in. + "sdk/agrifood/*/api/*.cs", + "sdk/communication/*/api/*.cs", + "sdk/compute/*/api/*.cs", + "sdk/containerregistry/*/api/*.cs", + "sdk/cosmosdb/*/api/*.cs", + "sdk/digitaltwins/*/api/*.cs", + "sdk/dns/*/api/*.cs", + "sdk/eventgrid/*/api/*.cs", + "sdk/insights/*/api/*.cs", + "sdk/machinelearningservices/*/api/*.cs", + "sdk/modelsrepository/*/api/*.cs", + "sdk/monitor/*/api/*.cs", + "sdk/network/*/api/*.cs", + "sdk/objectanchors/*/api/*.cs", + "sdk/purview/*/api/*.cs", + "sdk/remoterendering/*/api/*.cs", + "sdk/sqlmanagement/*/api/*.cs", + "sdk/synapse/*/api/*.cs", + "sdk/videoanalyzer/*/api/*.cs" ], // cspell is not case sensitive // Sort words alphabetically to make this list easier to use @@ -38,6 +60,7 @@ "deserializable", "deserializes", "diagnoser", + "dont", "dtmf", "epsg", "expando", @@ -63,7 +86,10 @@ "unhold", "uninstrumented", "westus", - "xunit" + "xunit", + "vnet", + "unencrypted", + "personalizer" ], "overrides": [ { diff --git a/eng/pipelines/aggregate-reports.yml b/eng/pipelines/aggregate-reports.yml index 20dfef1641f1c..28edce4a2fa91 100644 --- a/eng/pipelines/aggregate-reports.yml +++ b/eng/pipelines/aggregate-reports.yml @@ -35,14 +35,12 @@ jobs: - pwsh: | npx cspell lint ` --config ./.vscode/cspell.json ` - ./sdk/**/api/*.cs + --no-must-find-files ` + 'sdk/*/*/api/*.cs' displayName: Check spelling of public API surface - # Spelling errors in public api surface are not blockers yet but will + # Spelling errors in public api surface are not blockers yet but will # become blockers when this is rolled out to all services. For now, turn # the pipeline yellow if spelling errors are detected but do not block. - # Individual services can be blocked on spelling errors using: - # `SpellCheckPublicApiSurface: true` - # in the archetype-sdk-client.yml template invocation continueOnError: true - template: /eng/common/pipelines/templates/steps/verify-links.yml diff --git a/eng/pipelines/templates/jobs/ci.yml b/eng/pipelines/templates/jobs/ci.yml index 57b59af52fe89..16e131b2ea9c9 100644 --- a/eng/pipelines/templates/jobs/ci.yml +++ b/eng/pipelines/templates/jobs/ci.yml @@ -33,9 +33,6 @@ parameters: - name: MatrixReplace type: object default: [] -- name: SpellCheckPublicApiSurface - type: boolean - default: false jobs: - job: Build @@ -140,7 +137,7 @@ jobs: arguments: > -ServiceDirectory ${{ parameters.ServiceToTest }} -SDKType ${{ parameters.SDKType }} - -SpellCheckPublicApiSurface:$${{ parameters.SpellCheckPublicApiSurface }} + -SpellCheckPublicApiSurface pwsh: true failOnStderr: false - task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0 diff --git a/eng/pipelines/templates/stages/archetype-sdk-client.yml b/eng/pipelines/templates/stages/archetype-sdk-client.yml index b356d0fc7997a..7bcd047ac55d7 100644 --- a/eng/pipelines/templates/stages/archetype-sdk-client.yml +++ b/eng/pipelines/templates/stages/archetype-sdk-client.yml @@ -53,9 +53,6 @@ parameters: - name: MatrixReplace type: object default: [] -- name: SpellCheckPublicApiSurface - type: boolean - default: false variables: - template: ../variables/globals.yml @@ -74,7 +71,6 @@ stages: ArtifactName: packages TestSetupSteps: ${{ parameters.TestSetupSteps }} TestTimeoutInMinutes: ${{ parameters.TestTimeoutInMinutes }} - SpellCheckPublicApiSurface: ${{ parameters.SpellCheckPublicApiSurface }} MatrixConfigs: - ${{ each config in parameters.MatrixConfigs }}: - ${{ config }} diff --git a/eng/scripts/Export-API.ps1 b/eng/scripts/Export-API.ps1 index 688cddf438685..9855ce9428697 100644 --- a/eng/scripts/Export-API.ps1 +++ b/eng/scripts/Export-API.ps1 @@ -20,6 +20,7 @@ if ($SpellCheckPublicApiSurface) { Write-Host "Spell check public API surface" npx cspell lint ` --config "$PSScriptRoot/../../.vscode/cspell.json" ` + --no-must-find-files ` "$PSScriptRoot/../../sdk/$ServiceDirectory/*/api/*.cs" if ($LASTEXITCODE) { Write-Host "##vso[task.LogIssue type=error;]Spelling errors detected. To correct false positives or learn about spell checking see: https://aka.ms/azsdk/engsys/spellcheck" diff --git a/sdk/formrecognizer/ci.yml b/sdk/formrecognizer/ci.yml index e806f5d7daa4e..dd76d576ba691 100644 --- a/sdk/formrecognizer/ci.yml +++ b/sdk/formrecognizer/ci.yml @@ -25,7 +25,6 @@ extends: template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml parameters: ServiceDirectory: formrecognizer - SpellCheckPublicApiSurface: true ArtifactName: packages Artifacts: - name: Azure.AI.FormRecognizer diff --git a/sdk/storage/ci.yml b/sdk/storage/ci.yml index a5794aad2ace8..ff6e382028616 100644 --- a/sdk/storage/ci.yml +++ b/sdk/storage/ci.yml @@ -25,7 +25,6 @@ extends: template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml parameters: ServiceDirectory: storage - SpellCheckPublicApiSurface: true ArtifactName: packages Artifacts: - name: Azure.Storage.Blobs diff --git a/sdk/textanalytics/ci.yml b/sdk/textanalytics/ci.yml index 2e9e691f803ab..315827e3e96a5 100644 --- a/sdk/textanalytics/ci.yml +++ b/sdk/textanalytics/ci.yml @@ -25,7 +25,6 @@ extends: template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml parameters: ServiceDirectory: textanalytics - SpellCheckPublicApiSurface: true ArtifactName: packages Artifacts: - name: Azure.AI.TextAnalytics diff --git a/sdk/translation/ci.yml b/sdk/translation/ci.yml index f8cbd2ae4c692..aebe750fd403a 100644 --- a/sdk/translation/ci.yml +++ b/sdk/translation/ci.yml @@ -25,7 +25,6 @@ extends: parameters: ServiceDirectory: translation ArtifactName: packages - SpellCheckPublicApiSurface: true Artifacts: - name: Azure.AI.Translation.Document safeName: AzureAITranslationDocument