-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Update build check documentation #12750
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
base: main
Are you sure you want to change the base?
Conversation
Updated link in README to point to the correct Check class.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the build check documentation to reflect API naming changes from BuildExecutionCheck to Check and BuildExecutionCheckRule to CheckRule. The changes update references and code examples in the documentation files to match the current API.
Key Changes:
- Updated class name references from
BuildExecutionChecktoCheckin specification and README files - Updated type references from
BuildExecutionCheckRuletoCheckRulein code examples - Updated GitHub links to point to the renamed
Checkclass
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Build/BuildCheck/Infrastructure/EditorConfig/README.md | Updated link reference from BuildExecutionCheck to Check class |
| documentation/specs/BuildCheck/BuildCheck.md | Updated class names in code examples from BuildExecutionCheck to Check and BuildExecutionCheckRule to CheckRule |
| #### Custom configuration data | ||
| CustomConfigurationData is propogated to the BuildCheck Check instance by passing the instance of [ConfigurationContext](https://github.com/dotnet/msbuild/blob/393c2fea652873416c8a2028810932a4fa94403f/src/Build/BuildCheck/API/ConfigurationContext.cs#L14) | ||
| during the initialization of the [BuildExecutionCheck](https://github.com/dotnet/msbuild/blob/393c2fea652873416c8a2028810932a4fa94403f/src/Build/BuildCheck/API/BuildExecutionCheck.cs#L36). | ||
| during the initialization of the [Check]([https://github.com/dotnet/msbuild/blob/main/src/Build/BuildCheck/API/Check.cs](https://github.com/dotnet/msbuild/blob/a73379bc4af3599eb79b899a7c4c56a6c0dff9ff/src/Build/BuildCheck/API/Check.cs#L34)). |
Copilot
AI
Nov 11, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The markdown link syntax is malformed. The URL is nested inside another markdown link syntax, creating an invalid structure.
The current syntax:
[Check]([https://github.com/dotnet/msbuild/blob/main/src/Build/BuildCheck/API/Check.cs](https://github.com/dotnet/msbuild/blob/a73379bc4af3599eb79b899a7c4c56a6c0dff9ff/src/Build/BuildCheck/API/Check.cs#L34))Should be:
[Check](https://github.com/dotnet/msbuild/blob/a73379bc4af3599eb79b899a7c4c56a6c0dff9ff/src/Build/BuildCheck/API/Check.cs#L34)Remove the extra brackets and the duplicate URL.
| during the initialization of the [Check]([https://github.com/dotnet/msbuild/blob/main/src/Build/BuildCheck/API/Check.cs](https://github.com/dotnet/msbuild/blob/a73379bc4af3599eb79b899a7c4c56a6c0dff9ff/src/Build/BuildCheck/API/Check.cs#L34)). | |
| during the initialization of the [Check](https://github.com/dotnet/msbuild/blob/a73379bc4af3599eb79b899a7c4c56a6c0dff9ff/src/Build/BuildCheck/API/Check.cs#L34). |
|
|
||
|
|
||
| #### Custom configuration data | ||
| CustomConfigurationData is propogated to the BuildCheck Check instance by passing the instance of [ConfigurationContext](https://github.com/dotnet/msbuild/blob/393c2fea652873416c8a2028810932a4fa94403f/src/Build/BuildCheck/API/ConfigurationContext.cs#L14) |
Copilot
AI
Nov 11, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word "propogated" is misspelled. It should be "propagated" (with an 'a' in the middle).
| CustomConfigurationData is propogated to the BuildCheck Check instance by passing the instance of [ConfigurationContext](https://github.com/dotnet/msbuild/blob/393c2fea652873416c8a2028810932a4fa94403f/src/Build/BuildCheck/API/ConfigurationContext.cs#L14) | |
| CustomConfigurationData is propagated to the BuildCheck Check instance by passing the instance of [ConfigurationContext](https://github.com/dotnet/msbuild/blob/393c2fea652873416c8a2028810932a4fa94403f/src/Build/BuildCheck/API/ConfigurationContext.cs#L14) |
Update build check documentation