Skip to content

Enable Spell Checking within the Pipeline - #31526

Merged
jairmyree merged 9 commits into
mainfrom
jairmyree/spelling
Oct 20, 2022
Merged

Enable Spell Checking within the Pipeline#31526
jairmyree merged 9 commits into
mainfrom
jairmyree/spelling

Conversation

@jairmyree

@jairmyree jairmyree commented Oct 17, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

We are enabling spell checking in the pipeline.

Spell-Check Excluded Packages

These packages are being excluded from spell checking within the pipeline

Codeowners are responsible for resolving their spelling errors and removing their packages from the exclusions list

The excluded packages:

sdk/agrifood/azure-verticals-agrifood-farming/

sdk/anomalydetector/azure-ai-anomalydetector/

sdk/aot/azure-aot-graalvm-perf/

sdk/aot/azure-aot-graalvm-support-netty/

sdk/aot/azure-aot-graalvm-support/

sdk/appconfiguration/azure-data-appconfiguration-perf/

sdk/appconfiguration/azure-data-appconfiguration/

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config-web/

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config/

sdk/appconfiguration/azure-spring-cloud-feature-management-web/

sdk/appconfiguration/azure-spring-cloud-feature-management/

sdk/appconfiguration/azure-spring-cloud-starter-appconfiguration-config/

sdk/appconfiguration/azure-spring-cloud-test-appconfiguration-config/

sdk/attestation/azure-security-attestation/

sdk/boms/azure-sdk-bom/

sdk/boms/azure-sdk-template-bom/

sdk/boms/spring-cloud-azure-dependencies/

sdk/cognitiveservices/ms-azure-cs-autosuggest/

sdk/cognitiveservices/ms-azure-cs-computervision/

sdk/cognitiveservices/ms-azure-cs-contentmoderator/

sdk/cognitiveservices/ms-azure-cs-customimagesearch/

sdk/cognitiveservices/ms-azure-cs-customsearch/

sdk/cognitiveservices/ms-azure-cs-customvision-prediction/

sdk/cognitiveservices/ms-azure-cs-customvision-training/

sdk/cognitiveservices/ms-azure-cs-entitysearch/

sdk/cognitiveservices/ms-azure-cs-faceapi/

sdk/cognitiveservices/ms-azure-cs-imagesearch/

sdk/cognitiveservices/ms-azure-cs-luis-authoring/

sdk/cognitiveservices/ms-azure-cs-luis-runtime/

sdk/cognitiveservices/ms-azure-cs-newssearch/

sdk/cognitiveservices/ms-azure-cs-qnamaker/

sdk/cognitiveservices/ms-azure-cs-spellcheck/

sdk/cognitiveservices/ms-azure-cs-textanalytics/

sdk/cognitiveservices/ms-azure-cs-videosearch/

sdk/cognitiveservices/ms-azure-cs-visualsearch/

sdk/cognitiveservices/ms-azure-cs-websearch/

sdk/communication/azure-communication-callautomation/

sdk/communication/azure-communication-callingserver/

sdk/communication/azure-communication-chat/

sdk/communication/azure-communication-common-perf/

sdk/communication/azure-communication-common/

sdk/communication/azure-communication-email/

sdk/communication/azure-communication-identity/

sdk/communication/azure-communication-jobrouter/

sdk/communication/azure-communication-networktraversal/

sdk/communication/azure-communication-phonenumbers/

sdk/communication/azure-communication-rooms/

sdk/communication/azure-communication-sms/

sdk/confidentialledger/azure-security-confidentialledger/

sdk/containerregistry/azure-containers-containerregistry-perf/

sdk/containerregistry/azure-containers-containerregistry/

sdk/core/.idea/

sdk/core/azure-core-amqp-experimental/

sdk/core/azure-core-amqp/

sdk/core/azure-core-experimental/

sdk/core/azure-core-http-jdk-httpclient/

sdk/core/azure-core-http-netty/

sdk/core/azure-core-http-okhttp/

sdk/core/azure-core-http-vertx/

sdk/core/azure-core-management/

sdk/core/azure-core-metrics-opentelemetry/

sdk/core/azure-core-perf/

sdk/core/azure-core-serializer-avro-apache/

sdk/core/azure-core-serializer-avro-jackson/

sdk/core/azure-core-serializer-json-gson/

sdk/core/azure-core-serializer-json-jackson/

sdk/core/azure-core-test/

sdk/core/azure-core-tracing-opentelemetry/

sdk/core/azure-core/

sdk/core/azure-json-gson/

sdk/core/azure-json/

sdk/core/azure-xml/

sdk/cosmos/azure-cosmos-benchmark/

sdk/cosmos/azure-cosmos-dotnet-benchmark/

sdk/cosmos/azure-cosmos-encryption/

sdk/cosmos/azure-cosmos-spark_3_2-12/

sdk/cosmos/azure-cosmos-spark_3-1_2-12/

sdk/cosmos/azure-cosmos-spark_3-2_2-12/

sdk/cosmos/azure-cosmos/

sdk/cosmos/azure-spring-data-cosmos-test/

sdk/cosmos/azure-spring-data-cosmos/

sdk/deviceupdate/azure-iot-deviceupdate/

sdk/digitaltwins/azure-digitaltwins-core/

sdk/e2e/src/

sdk/eventgrid/azure-messaging-eventgrid-cloudnative-cloudevents/

sdk/eventgrid/azure-messaging-eventgrid/

sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/

sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-jedis/

sdk/eventhubs/azure-messaging-eventhubs-stress/

sdk/eventhubs/azure-messaging-eventhubs-track1-perf/

sdk/eventhubs/azure-messaging-eventhubs-track2-perf/

sdk/eventhubs/azure-messaging-eventhubs/

sdk/formrecognizer/azure-ai-formrecognizer-perf/

sdk/formrecognizer/azure-ai-formrecognizer/

sdk/identity/azure-identity-perf/

sdk/identity/azure-identity/

sdk/jdbc/azure-identity-providers-jdbc-mysql/

sdk/jdbc/azure-identity-providers-jdbc-postgresql/

sdk/keyvault/azure-security-keyvault-administration/

sdk/keyvault/azure-security-keyvault-certificates/

sdk/keyvault/azure-security-keyvault-jca/

sdk/keyvault/azure-security-keyvault-keys/

sdk/keyvault/azure-security-keyvault-perf/

sdk/keyvault/azure-security-keyvault-secrets/

sdk/keyvault/azure-security-test-keyvault-jca/

sdk/maps/azure-maps-elevation/

sdk/maps/azure-maps-geolocation/

sdk/maps/azure-maps-render/

sdk/maps/azure-maps-route/

sdk/maps/azure-maps-search/

sdk/maps/azure-maps-timezone/

sdk/metricsadvisor/azure-ai-metricsadvisor-perf/

sdk/metricsadvisor/azure-ai-metricsadvisor/

sdk/mixedreality/azure-mixedreality-authentication/

sdk/modelsrepository/azure-iot-modelsrepository/

sdk/monitor/azure-monitor-ingestion-perf/

sdk/monitor/azure-monitor-ingestion/

sdk/monitor/azure-monitor-opentelemetry-exporter/

sdk/monitor/azure-monitor-query-perf/

sdk/monitor/azure-monitor-query/

sdk/parents/azure-client-sdk-parent/

sdk/parents/azure-data-sdk-parent/

sdk/parents/azure-perf-test-parent/

sdk/parents/azure-sdk-parent/

sdk/personalizer/azure-ai-personalizer/

sdk/purview/azure-analytics-purview-administration/

sdk/purview/azure-analytics-purview-catalog/

sdk/purview/azure-analytics-purview-scanning/

sdk/quantum/azure-quantum-jobs/

sdk/remoterendering/azure-mixedreality-remoterendering/

sdk/remoterendering/TestResources/

sdk/schemaregistry/azure-data-schemaregistry-apacheavro/

sdk/schemaregistry/azure-data-schemaregistry/

sdk/search/.idea/

sdk/search/azure-search-documents/

sdk/search/azure-search-perf/

sdk/servicebus/azure-messaging-servicebus-track1-perf/

sdk/servicebus/azure-messaging-servicebus-track2-perf/

sdk/servicebus/azure-messaging-servicebus/

sdk/servicebus/build/

sdk/spring-experimental/spring-cloud-azure-native-configuration/

sdk/spring/scripts/

sdk/spring/spring-cloud-azure-actuator-autoconfigure/

sdk/spring/spring-cloud-azure-actuator/

sdk/spring/spring-cloud-azure-autoconfigure/

sdk/spring/spring-cloud-azure-core/

sdk/spring/spring-cloud-azure-integration-tests/

sdk/spring/spring-cloud-azure-service/

sdk/spring/spring-cloud-azure-starter-active-directory-b2c/

sdk/spring/spring-cloud-azure-starter-active-directory/

sdk/spring/spring-cloud-azure-starter-actuator/

sdk/spring/spring-cloud-azure-starter-appconfiguration/

sdk/spring/spring-cloud-azure-starter-cosmos/

sdk/spring/spring-cloud-azure-starter-data-cosmos/

sdk/spring/spring-cloud-azure-starter-eventhubs/

sdk/spring/spring-cloud-azure-starter-integration-eventhubs/

sdk/spring/spring-cloud-azure-starter-integration-servicebus/

sdk/spring/spring-cloud-azure-starter-integration-storage-queue/

sdk/spring/spring-cloud-azure-starter-jdbc-mysql/

sdk/spring/spring-cloud-azure-starter-jdbc-postgresql/

sdk/spring/spring-cloud-azure-starter-keyvault-certificates/

sdk/spring/spring-cloud-azure-starter-keyvault-secrets/

sdk/spring/spring-cloud-azure-starter-keyvault/

sdk/spring/spring-cloud-azure-starter-servicebus-jms/

sdk/spring/spring-cloud-azure-starter-servicebus/

sdk/spring/spring-cloud-azure-starter-storage-blob/

sdk/spring/spring-cloud-azure-starter-storage-file-share/

sdk/spring/spring-cloud-azure-starter-storage-queue/

sdk/spring/spring-cloud-azure-starter-storage/

sdk/spring/spring-cloud-azure-starter-stream-eventhubs/

sdk/spring/spring-cloud-azure-starter-stream-servicebus/

sdk/spring/spring-cloud-azure-starter/

sdk/spring/spring-cloud-azure-stream-binder-eventhubs-core/

sdk/spring/spring-cloud-azure-stream-binder-eventhubs/

sdk/spring/spring-cloud-azure-stream-binder-servicebus-core/

sdk/spring/spring-cloud-azure-stream-binder-servicebus/

sdk/spring/spring-cloud-azure-test-eventhubs-binder/

sdk/spring/spring-cloud-azure-test-servicebus-binder/

sdk/spring/spring-cloud-azure-trace-sleuth/

sdk/spring/spring-integration-azure-core/

sdk/spring/spring-integration-azure-eventhubs/

sdk/spring/spring-integration-azure-servicebus/

sdk/spring/spring-integration-azure-storage-queue/

sdk/spring/spring-messaging-azure-eventhubs/

sdk/spring/spring-messaging-azure-servicebus/

sdk/spring/spring-messaging-azure-storage-queue/

sdk/spring/spring-messaging-azure/

sdk/storage/azure-storage-blob-batch/

sdk/storage/azure-storage-blob-changefeed/

sdk/storage/azure-storage-blob-cryptography/

sdk/storage/azure-storage-blob-nio/

sdk/storage/azure-storage-blob/

sdk/storage/azure-storage-common/

sdk/storage/azure-storage-file-datalake/

sdk/storage/azure-storage-file-share/

sdk/storage/azure-storage-internal-avro/

sdk/storage/azure-storage-perf/

sdk/storage/azure-storage-queue/

sdk/synapse/azure-analytics-synapse-accesscontrol/

sdk/synapse/azure-analytics-synapse-artifacts/

sdk/synapse/azure-analytics-synapse-managedprivateendpoints/

sdk/synapse/azure-analytics-synapse-monitoring/

sdk/synapse/azure-analytics-synapse-spark/

sdk/tables/.idea/

sdk/tables/azure-data-tables-perf/

sdk/tables/azure-data-tables/

sdk/template/azure-sdk-template-three/

sdk/template/azure-sdk-template-two/

sdk/template/azure-sdk-template/

sdk/template/azure-template-perf/

sdk/textanalytics/azure-ai-textanalytics-perf/

sdk/textanalytics/azure-ai-textanalytics/

sdk/tools/azure-sdk-archetype/

sdk/tools/azure-sdk-build-tool/

sdk/translation/azure-ai-documenttranslator/

sdk/videoanalyzer/azure-media-videoanalyzer-edge/

sdk/webpubsub/azure-messaging-webpubsub/

sdk/aot/azure-aot-graalvm-samples/

sdk\devcenter\azure-developer-devcenter/

jairmyree and others added 3 commits October 6, 2022 15:59
@jairmyree
The Cspell.json has the necessary directories ignored
357c6e5
@jairmyree
Merge branch 'main' of https://github.com/Azure/azure-sdk-for-java in…
eac3748 
…to jairmyree/spelling
@jairmyree @danieljurek
Enable Cspell in the Pipeline (#30903)
ee72d71 
* I've combined the two existing cspell.json files but there may be more that we want to add to this file, so I'm making the PR a draft so you can at least take a look.

* Enable spell check failure

Co-authored-by: Daniel Jurek <djurek@microsoft.com>
@jairmyree jairmyree changed the title Jairmyree/spelling Enable Spell Checking within the Pipeline Oct 17, 2022
danieljurek
danieljurek reviewed Oct 17, 2022
View reviewed changes

@danieljurek danieljurek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple things to do:

  1. Remove any entries from cspell.json that have azure-resourcemanager in the package path. These should already be excluded by **/azure-resourcemanager*/**
  2. Remove any entries that have microsoft-azure these should already be excluded by **/microsoft-azure-*/**
  3. Run the spelling2.ps1 script again, make sure there are no new entries to add.

@jairmyree

jairmyree commented Oct 19, 2022

Copy link
Copy Markdown
Member Author

@danieljurek I've done the things you left in your comment. Please take another look when you get a chance.

danieljurek
danieljurek reviewed Oct 20, 2022
View reviewed changes

@danieljurek danieljurek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. I think we're close here.

Next steps:

  1. Address the remaining feedback items
  2. Let's set up some time to run through the issue opening script a couple times before we merge this
  3. Run the issue opening script
  4. Merge this PR

Comment thread .vscode/cspell.json Outdated
Comment thread .vscode/cspell.json Outdated
Comment thread .vscode/cspell.json
Comment thread .vscode/cspell.json
Comment thread .vscode/cspell.json Outdated
@danieljurek

danieljurek commented Oct 20, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

The process for the issue opening script has several steps:

  1. Edit cspell.json to remove all of the directories we'd previously opted out (don't check in this change) ... This way when we run spelling2.ps1 the spelling errors will show up again.
  2. In spelling2.ps1 comment out the exit 0 line before the issue opening section.
  3. Set a breakpoint in spelling2.ps1 issue opening loop
  4. Run the script in debug mode (wait for it to check all the files again, prompt for a PR#, and then hit the breakpoint)
  5. Step through one or two issue creations and ensure that they are done correctly
  6. Remove the breakpoint and let the script finish

This was referenced Oct 20, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Oct 20, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
danieljurek
danieljurek approved these changes Oct 20, 2022
View reviewed changes

@danieljurek danieljurek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 🚢 🇮🇹

@jairmyree
jairmyree merged commit 78c6516 into main Oct 20, 2022
@jairmyree
jairmyree deleted the jairmyree/spelling branch October 20, 2022 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danieljurek danieljurek danieljurek approved these changes
@hallipr hallipr Awaiting requested review from hallipr
@JimSuplizio JimSuplizio Awaiting requested review from JimSuplizio

Assignees

@danieljurek danieljurek

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jairmyree @danieljurek