Skip to content

Conversation

@danieljurek
Copy link
Member

  • include documentation
  • add eng/common to exclusion list
  • add language-specific dictionary to 'dictionaries' entry to avoid false positives in language-specific keywords in documentation or other files

@check-enforcer
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaluation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run cpp - [service] - ci

@antkmsft
Copy link
Member

antkmsft commented Aug 11, 2021

Thank you @danieljurek! Does this mean that we can update this dictionary to allow Unicode words that are not in the dictionary (https://github.com/Azure/azure-sdk-for-cpp/pull/2551/files#diff-cc1b46c667702f97b0f4104c7637ccca9da686d2df0cd9e47a39f12ced659897L17)?
So, with this fix, "Jørgen" being added to the list, there would be no error during the release?

Or is it to fix some different part of the spell check/address different part of the system? (because last time, the spell check did not fail the PR with "Jørgen", and only during the release we did find out)

@danieljurek
Copy link
Member Author

@antkmsft -- the unicode error we encountered on release was not the result of a spell check failing so this update doesn't address that. It was a failure that occurred when we attempted to post to the GitHub API some content for a release.

This PR is some cleanup work being done in each repo ahead of this PR which will give teams the ability to opt into failing CI when spelling errors are detected in PRs -- Azure/azure-sdk-tools#1887

…n list, add language-specific dictionary to 'dictionaries' entry to avoid false positives in language-specific keywords in documentation or other files
@danieljurek danieljurek force-pushed the cspell-configuration branch from 82a44c6 to 42f76ae Compare August 16, 2021 17:03
@danieljurek danieljurek requested a review from a team as a code owner August 16, 2021 17:03
default: 'sdk/*/*/*cov_xml.xml'
- name: FailOnSpellingErrors
type: boolean
default: false
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason to add this until we ready to set it to true in at lease one place?

Also we seem to be adding in some double negatives (i.e. not(Fail..)) I wonder if we if we should call this ContinueOnSpellingErrors just to align with what we are passing it to.

Copy link
Member Author

Choose a reason for hiding this comment

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

I had other names which were worse... ContinueOnSpellingErrors is much better than anything I had this morning.

Copy link
Member Author

Choose a reason for hiding this comment

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

Also, the reason to add this is to give people the ability to opt into it when ready.

@RickWinter
Copy link
Member

@danieljurek Is this waiting on anything?

@danieljurek
Copy link
Member Author

This should be closed in favor of #2794

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