Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check spelling using GitHub Actions + Baseline #31810

Closed
wants to merge 55 commits into from
Closed

Check spelling using GitHub Actions + Baseline #31810

wants to merge 55 commits into from

Conversation

danieljurek
Copy link
Member

@danieljurek danieljurek commented Dec 9, 2024 •
edited
Loading

Opening as a draft PR to prevent bringing in a wide audience of reviewers. It might be necessary to use admin capabilities to merge this one.

This PR:

  • Sets baseline spelling configs
    • Use root cspell.json for words that appear correctly spelled and are seen in 10 or more services
    • Use specification/<service>/cspell.json for other errors, flattened to list words instead of targeting specific files with overrides
  • Update documentation
  • Uses GitHub Actions to run spell check:
    • In PRs on changed files
    • On all specification/ files when pushing to targeted branches (matching TSV - All config), a schedule, or when run manually

Example PR with spelling error (PR):

image

Workflow run for same PR with no spelling error (workflow run):

image

Check Spelling - All runs:

Future improvements to Invoke-Cspell.ps1 should include the ability to silence the entire list of files checked.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 9, 2024 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named Swagger SemanticValidation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 9, 2024 •
edited
Loading

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@danieljurek
Copy link
Member Author

There is currently a merge conflict because of contention in the custom-words.txt file. I'll establish a new baseline before merging this PR.

@danieljurek danieljurek force-pushed the djurek/cspell-baseline branch from 1b44e53 to ce6c8cd Compare December 10, 2024 04:33
@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

1 similar comment
@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

1 similar comment
@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@danieljurek danieljurek force-pushed the djurek/cspell-baseline branch from 114aaca to 4592bf1 Compare December 11, 2024 23:30
@danieljurek danieljurek force-pushed the djurek/cspell-baseline branch from 6826cea to b18e55d Compare December 12, 2024 05:05
mikeharder
mikeharder requested changes Dec 13, 2024
View reviewed changes
Copy link
Member

@mikeharder mikeharder left a comment

Choose a reason for hiding this comment

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

Let's get consensus on the new check name before merging, since I don't want to need to change the GitHub setting more than once.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 17, 2024 •
edited
Loading

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.AwsConnector
AnomalyDetector
ApiCenter.DataApi
Microsoft.ApiCenter
Microsoft.AppComplianceAutomation
AzureAppConfiguration
Azure.Monitor.LiveMetrics
Astronomer.Astro
Azure.AI.ChatProtocol
DocumentTranslation
TextTranslation
PurviewDataMap
Azure.Batch
Microsoft.EventGrid
Microsoft.EventGrid.SystemEvents
Azure.ProgrammableConnectivity
Microsoft.MachineLearningServices
Microsoft.AzureFleet
Microsoft.AzureLargeInstance
Microsoft.AzureStackHCI
Microsoft.CodeSigning
AzureCommunicationRoutingService
Azure.Communication.MessagesService
Microsoft.Community
Microsoft.ComputeSchedule
Microsoft.ConnectedCache
Microsoft.ContainerStorage
ContentSafety
Microsoft.Contoso
Azure.Contoso.WidgetManager
Microsoft.PortalServices
Microsoft.Portal
Microsoft.DatabaseWatcher
DevCenterService
Microsoft.DeviceRegistry
Microsoft.DocumentDB
DocumentIntelligence
Microsoft.DurableTask
Easm
Microsoft.EdgeZones
Face
Microsoft.ContainerService
GitHub.Network
HealthDataAIServices.DeidServices
Microsoft.HealthDataAIServices
AzureHealthInsights
ImageAnalysis
Microsoft.Impact
Informatica.DataManagement
Microsoft.IoTOperations
Microsoft.IoTOperationsDataProcessor
Microsoft.IoTOperationsMQ
Microsoft.IoTOperationsOrchestrator
Microsoft.KubernetesRuntime
Language.Conversations.Authoring
Language.AnalyzeDocuments
Language.Text
Language.Text.Authoring
Language.Conversations
Microsoft.LoadTestService
Microsoft.App.DynamicSessions
Microsoft.AVS
Microsoft.AzureTerraform
Microsoft.CodeTransparency
Microsoft.DevOpsInfrastructure
Microsoft.Edge
Microsoft.Fabric
Microsoft.ManagedCcf
Microsoft.Monitor
Microsoft.VerifiedId
Neon.Postgres
Microsoft.NetworkAnalytics
Azure.AI.OpenAI.Assistants
Azure.OpenAI
Oracle.Database
Pinecone.VectorDb
Microsoft.PlaywrightTesting.AuthManager
Microsoft.AzurePlaywrightService
Microsoft.ProgrammableConnectivity
Microsoft.HybridConnectivity
Microsoft.Purview
Quantum.Workspace.Services
Qumulo.Storage
SchemaRegistry
Microsoft.ScVmm
Microsoft.SecretSyncController
Microsoft.ServiceNetworking
Microsoft.Speech.VideoTranslation
Microsoft.AzureSphere
SplitIO.Experimentation
Microsoft.StandbyPool
Azure.Developer.TrustedSigning
Microsoft.VoiceServices
Microsoft.Workloads

@danieljurek danieljurek mentioned this pull request Dec 17, 2024
Merged
@danieljurek
Copy link
Member Author

danieljurek commented Jan 8, 2025 •
edited
Loading

Work items from today's discussion:

  • Keep the baseline as it's already done
  • Convert to YAML
  • Commentary in the YAML describing what to do
  • all words lowercase

@danieljurek danieljurek mentioned this pull request Jan 8, 2025
Closed
@danieljurek
Copy link
Member Author

Handled in #32171

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikeharder mikeharder mikeharder requested changes

@weshaggard weshaggard weshaggard approved these changes

@benbp benbp Awaiting requested review from benbp benbp will be requested when the pull request is marked ready for review benbp is a code owner

@raych1 raych1 Awaiting requested review from raych1 raych1 will be requested when the pull request is marked ready for review raych1 is a code owner

@maririos maririos Awaiting requested review from maririos maririos will be requested when the pull request is marked ready for review maririos is a code owner

@dazilb dazilb Awaiting requested review from dazilb dazilb will be requested when the pull request is marked ready for review dazilb is a code owner

@tshoham tshoham Awaiting requested review from tshoham tshoham will be requested when the pull request is marked ready for review tshoham is a code owner

@omerhaimov omerhaimov Awaiting requested review from omerhaimov omerhaimov will be requested when the pull request is marked ready for review omerhaimov is a code owner

@bermanraz bermanraz Awaiting requested review from bermanraz bermanraz will be requested when the pull request is marked ready for review bermanraz is a code owner

@Einav94 Einav94 Awaiting requested review from Einav94 Einav94 will be requested when the pull request is marked ready for review Einav94 is a code owner

@naveedaz naveedaz Awaiting requested review from naveedaz naveedaz will be requested when the pull request is marked ready for review naveedaz is a code owner

@wanyang7 wanyang7 Awaiting requested review from wanyang7 wanyang7 will be requested when the pull request is marked ready for review wanyang7 is a code owner

@atpham256 atpham256 Awaiting requested review from atpham256 atpham256 will be requested when the pull request is marked ready for review atpham256 is a code owner

@ankushbindlish2 ankushbindlish2 Awaiting requested review from ankushbindlish2 ankushbindlish2 will be requested when the pull request is marked ready for review ankushbindlish2 is a code owner

@jamestao jamestao Awaiting requested review from jamestao jamestao will be requested when the pull request is marked ready for review jamestao is a code owner

@ericshape ericshape Awaiting requested review from ericshape ericshape will be requested when the pull request is marked ready for review ericshape is a code owner

@jeremyfrosti jeremyfrosti Awaiting requested review from jeremyfrosti jeremyfrosti will be requested when the pull request is marked ready for review jeremyfrosti is a code owner

@samedder samedder Awaiting requested review from samedder samedder will be requested when the pull request is marked ready for review samedder is a code owner

@v-Ajnava v-Ajnava Awaiting requested review from v-Ajnava v-Ajnava will be requested when the pull request is marked ready for review v-Ajnava is a code owner

@dsouzaarun dsouzaarun Awaiting requested review from dsouzaarun dsouzaarun will be requested when the pull request is marked ready for review dsouzaarun is a code owner

@damodaravadhani damodaravadhani Awaiting requested review from damodaravadhani damodaravadhani will be requested when the pull request is marked ready for review damodaravadhani is a code owner

@TimLovellSmith TimLovellSmith Awaiting requested review from TimLovellSmith TimLovellSmith will be requested when the pull request is marked ready for review TimLovellSmith is a code owner

@kamboj-prjwl kamboj-prjwl Awaiting requested review from kamboj-prjwl kamboj-prjwl will be requested when the pull request is marked ready for review kamboj-prjwl is a code owner

@giakas giakas Awaiting requested review from giakas giakas will be requested when the pull request is marked ready for review giakas is a code owner

@NonStatic2014 NonStatic2014 Awaiting requested review from NonStatic2014 NonStatic2014 will be requested when the pull request is marked ready for review NonStatic2014 is a code owner

@vickm vickm Awaiting requested review from vickm vickm will be requested when the pull request is marked ready for review vickm is a code owner

@chen-karen chen-karen Awaiting requested review from chen-karen chen-karen will be requested when the pull request is marked ready for review chen-karen is a code owner

@cheathamb36 cheathamb36 Awaiting requested review from cheathamb36 cheathamb36 will be requested when the pull request is marked ready for review cheathamb36 is a code owner

@lgonsoulin lgonsoulin Awaiting requested review from lgonsoulin lgonsoulin will be requested when the pull request is marked ready for review lgonsoulin is a code owner

@rkmanda rkmanda Awaiting requested review from rkmanda rkmanda will be requested when the pull request is marked ready for review rkmanda is a code owner

@lmazuel lmazuel Awaiting requested review from lmazuel lmazuel will be requested when the pull request is marked ready for review lmazuel is a code owner

@yugangw-msft yugangw-msft Awaiting requested review from yugangw-msft yugangw-msft will be requested when the pull request is marked ready for review yugangw-msft is a code owner

@jsquire jsquire Awaiting requested review from jsquire jsquire will be requested when the pull request is marked ready for review jsquire is a code owner

@JoshLove-msft JoshLove-msft Awaiting requested review from JoshLove-msft JoshLove-msft will be requested when the pull request is marked ready for review JoshLove-msft is a code owner

@l0lawrence l0lawrence Awaiting requested review from l0lawrence l0lawrence will be requested when the pull request is marked ready for review l0lawrence is a code owner

@marcodalessandro marcodalessandro Awaiting requested review from marcodalessandro marcodalessandro will be requested when the pull request is marked ready for review marcodalessandro is a code owner

@rohankhandelwal rohankhandelwal Awaiting requested review from rohankhandelwal rohankhandelwal will be requested when the pull request is marked ready for review rohankhandelwal is a code owner

@riteshrao riteshrao Awaiting requested review from riteshrao riteshrao will be requested when the pull request is marked ready for review riteshrao is a code owner

@hitenjava hitenjava Awaiting requested review from hitenjava hitenjava will be requested when the pull request is marked ready for review hitenjava is a code owner

@Frey-Wang Frey-Wang Awaiting requested review from Frey-Wang Frey-Wang will be requested when the pull request is marked ready for review Frey-Wang is a code owner

@zhangyd2015 zhangyd2015 Awaiting requested review from zhangyd2015 zhangyd2015 will be requested when the pull request is marked ready for review zhangyd2015 is a code owner

@davidzhaoyue davidzhaoyue Awaiting requested review from davidzhaoyue davidzhaoyue will be requested when the pull request is marked ready for review davidzhaoyue is a code owner

@pjohari-ms pjohari-ms Awaiting requested review from pjohari-ms pjohari-ms will be requested when the pull request is marked ready for review pjohari-ms is a code owner

@palma21 palma21 Awaiting requested review from palma21 palma21 will be requested when the pull request is marked ready for review palma21 is a code owner

@matthchr matthchr Awaiting requested review from matthchr matthchr will be requested when the pull request is marked ready for review matthchr is a code owner

@kjeur kjeur Awaiting requested review from kjeur kjeur will be requested when the pull request is marked ready for review kjeur is a code owner

@Sandido Sandido Awaiting requested review from Sandido Sandido will be requested when the pull request is marked ready for review Sandido is a code owner

@dkulkarni-ms dkulkarni-ms Awaiting requested review from dkulkarni-ms dkulkarni-ms will be requested when the pull request is marked ready for review dkulkarni-ms is a code owner

@haagha haagha Awaiting requested review from haagha haagha will be requested when the pull request is marked ready for review haagha is a code owner

@MS-syh2qs MS-syh2qs Awaiting requested review from MS-syh2qs MS-syh2qs will be requested when the pull request is marked ready for review MS-syh2qs is a code owner

@grizzlytheodore grizzlytheodore Awaiting requested review from grizzlytheodore grizzlytheodore will be requested when the pull request is marked ready for review grizzlytheodore is a code owner

@mabhard mabhard Awaiting requested review from mabhard mabhard will be requested when the pull request is marked ready for review mabhard is a code owner

@yangyuan yangyuan Awaiting requested review from yangyuan yangyuan will be requested when the pull request is marked ready for review yangyuan is a code owner

@rrahulms rrahulms Awaiting requested review from rrahulms rrahulms will be requested when the pull request is marked ready for review rrahulms is a code owner

@ChenglongLiu ChenglongLiu Awaiting requested review from ChenglongLiu ChenglongLiu will be requested when the pull request is marked ready for review ChenglongLiu is a code owner

@wilcobmsft wilcobmsft Awaiting requested review from wilcobmsft wilcobmsft will be requested when the pull request is marked ready for review wilcobmsft is a code owner

@wiboris wiboris Awaiting requested review from wiboris wiboris will be requested when the pull request is marked ready for review wiboris is a code owner

@dpwatrous dpwatrous Awaiting requested review from dpwatrous dpwatrous will be requested when the pull request is marked ready for review dpwatrous is a code owner

@skapur12 skapur12 Awaiting requested review from skapur12 skapur12 will be requested when the pull request is marked ready for review skapur12 is a code owner

@cRui861 cRui861 Awaiting requested review from cRui861 cRui861 will be requested when the pull request is marked ready for review cRui861 is a code owner

@wanghoppe wanghoppe Awaiting requested review from wanghoppe wanghoppe will be requested when the pull request is marked ready for review wanghoppe is a code owner

@stankovski stankovski Awaiting requested review from stankovski stankovski will be requested when the pull request is marked ready for review stankovski is a code owner

@jijohn14 jijohn14 Awaiting requested review from jijohn14 jijohn14 will be requested when the pull request is marked ready for review jijohn14 is a code owner

@Juliehzl Juliehzl Awaiting requested review from Juliehzl Juliehzl will be requested when the pull request is marked ready for review Juliehzl is a code owner

@solankisamir solankisamir Awaiting requested review from solankisamir solankisamir will be requested when the pull request is marked ready for review solankisamir is a code owner

@hmlam hmlam Awaiting requested review from hmlam hmlam will be requested when the pull request is marked ready for review hmlam is a code owner

@deyaaeldeen deyaaeldeen Awaiting requested review from deyaaeldeen deyaaeldeen will be requested when the pull request is marked ready for review deyaaeldeen is a code owner

@swathipil swathipil Awaiting requested review from swathipil swathipil will be requested when the pull request is marked ready for review swathipil is a code owner

@conniey conniey Awaiting requested review from conniey conniey will be requested when the pull request is marked ready for review conniey is a code owner

@minhanh-phan minhanh-phan Awaiting requested review from minhanh-phan minhanh-phan will be requested when the pull request is marked ready for review minhanh-phan is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@danieljurek @azure-sdk @weshaggard @mikeharder