Skip to content

Comments

Update deps for spelling tool#6538

Merged
weshaggard merged 1 commit intoAzure:mainfrom
xirzec:updateSpellingDeps
Jul 19, 2023
Merged

Update deps for spelling tool#6538
weshaggard merged 1 commit intoAzure:mainfrom
xirzec:updateSpellingDeps

Conversation

@xirzec
Copy link
Member

@xirzec xirzec commented Jul 18, 2023

To resolve some scan issues with old transitive deps.

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@weshaggard weshaggard requested a review from danieljurek July 18, 2023 22:54
@weshaggard
Copy link
Member

@danieljurek how much risk do you think we have here?

@danieljurek
Copy link
Member

danieljurek commented Jul 19, 2023

I think this is OK to merge now as the mitigation for new spelling error detections is unchanged: If your PR is blocked, update the word list or fix your spelling errors.

Upgrading the whole of cspell at once is the right way to do this instead of a subset of cspell's dependencies.

I would rate this as relatively low risk because we've updated cspell in the past in response to problems and it hasn't resulted in catastrophic failures.

The failures I'd be concerned about when doing this are:

  1. Changes to the CLI interface that mean we need to update our scripts that call cspell (either with output parsing or CLI parameters) ... but the SemVer doesn't suggest any large breaks (assuming SemVer is used correctly in this context)
  2. Changes in the detection logic which result in a lot of new spelling errors. Off the top of my head, this can come from changes in how word boundaries are determined or elimination or refactoring of dictionary terms. This would be treated as any new spelling error detection: Update word list or fix spelling error in source.

Detailed testing of this change would have to be done on a per-repo basis as different languages scan at different levels of granularity: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/367/Capabilities-and-State

@weshaggard
Copy link
Member

Thanks @xirzec for starting this PR I took it through the sync process.

@xirzec xirzec deleted the updateSpellingDeps branch July 19, 2023 20:59
dgetu pushed a commit to Azure/azure-sdk-for-js that referenced this pull request Sep 6, 2023
Sync eng/common directory with azure-sdk-tools for PR
Azure/azure-sdk-tools#6538 See [eng/common
workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow)

Co-authored-by: Jeff Fisher <jeffish@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants