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.

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

cspell version 0.1 within the json file is outdated and needs to be upgraded to avoid CI failure #4395

Open
ahsonkhan opened this issue Mar 1, 2023 · 4 comments · Fixed by #4393
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. EngSys This issue is impacting the engineering system.

Comments

@ahsonkhan
Copy link
Member

From #4393

https://dev.azure.com/azure-sdk/public/_build/results?buildId=2597098&view=logs&j=a129effc-2dd1-54d1-fb5a-ad7bdc0e851d&t=7b4713e3-e110-5049-e231-cc8a1e664c68&l=27

Looks like version 0.1 is no longer supported:

{
"version": "0.1",

##[error]Legacy config file version found: "0.1", upgrade to "0.2"
##[error]  File: "D:\a\_work\1\s\.vscode\cspell.json"
Starting: Check spelling (cspell)
==============================================================================
Task         : PowerShell
Description  : Run a PowerShell script on Linux, macOS, or Windows
Version      : 2.212.0
Author       : Microsoft Corporation
Help         : https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/powershell
==============================================================================
Generating script.
Formatted command: . 'D:\a\_work\1\s\eng\common\scripts\check-spelling-in-changed-files.ps1' -CspellConfigPath ./.vscode/cspell.json -ExitWithError:(!$false)
========================== Starting Command Output ===========================
"C:\Program Files\PowerShell\7\pwsh.exe" -NoLogo -NoProfile -NonInteractive -ExecutionPolicy Unrestricted -Command ". 'D:\a\_work\_temp\a62d36cf-b824-4bdd-b129-bfad15637cd4.ps1'"
git -c core.quotepath=off -c i18n.logoutputencoding=utf-8 diff "origin/main...1ac504ff5bfdaef4ee1e549722b56a9d2d4bb1c6" --name-only --diff-filter=d
Here are the diff files:
    sdk/core/azure-core/CHANGELOG.md
Git Detected 1 changed file(s). Files checked by cspell may exclude files according to cspell.json
Setting config in: ./.vscode/cspell.json
npx cspell lint --config D:\a\_work\1\s\.vscode\cspell.json --no-must-find-files --root D:\a\_work\1\s\ --relative

1/2 .\D:\a\_work\1\s\LICENSE.txt 726.71ms

2/2 .\D:\a\_work\1\s\sdk\core\azure-core\CHANGELOG.md 168.77ms
CSpell: Files checked: 2, Issues found: 0 in 0 files
cspell run complete, restoring original configuration and removing temp file.
##[error]Legacy config file version found: "0.1", upgrade to "0.2"
##[error]  File: "D:\a\_work\1\s\.vscode\cspell.json"
##[error]Spelling errors detected. To correct false positives or learn about spell checking see: https://aka.ms/azsdk/engsys/spellcheck
##[error]PowerShell exited with code '1'.
Finishing: Check spelling (cspell)

@weshaggard, @danieljurek Presumably this will impact other repos as well, like .NET:
https://github.com/Azure/azure-sdk-for-net/blob/9440800d1fc64dbea79df6bb20ca95f1e0d837dd/.vscode/cspell.json#L2

@ahsonkhan ahsonkhan added the Central-EngSys This issue is owned by the Engineering System team. label Mar 1, 2023
@ahsonkhan
Copy link
Member Author

I updated the version in C++ to 0.2 here: #4393

@ahsonkhan
Copy link
Member Author

@danieljurek feel free to re-open this issue for other language repos like JS and .NET, as needed.

@danieljurek
Copy link
Member

The bug here is that the cspell version became unpinned and cspell's output changed breaking our spell checking logic.

We should upgrade the config version and cspell version in the future but that work should happen according to proper plans.

@danieljurek danieljurek reopened this Mar 2, 2023
@RickWinter RickWinter added the EngSys This issue is impacting the engineering system. label Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. EngSys This issue is impacting the engineering system.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants