Skip to content

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −3
Open

Update build check documentation #12750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a5c54d
Fix link to Check class in README
YuliiaKovalova Nov 11, 2025
656f271
Rename BuildExecutionCheck to Check in documentation
YuliiaKovalova Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/specs/BuildCheck/BuildCheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ To author custom check, user will need to implement given contract (delivered in
Simplified proposal:

```csharp
public abstract class BuildExecutionCheck : IDisposable
public abstract class Check : IDisposable
{
/// <summary>
/// Friendly name of the check.
Expand All @@ -259,7 +259,7 @@ public abstract class BuildExecutionCheck : IDisposable
/// <summary>
/// Single or multiple rules supported by the check.
/// </summary>
public abstract IReadOnlyList<BuildExecutionCheckRule> SupportedRules { get; }
public abstract IReadOnlyList<CheckRule> SupportedRules { get; }

/// <summary>
/// Optional initialization of the check.
Expand Down
2 changes: 1 addition & 1 deletion src/Build/BuildCheck/Infrastructure/EditorConfig/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Lifecycle of BuildCheckManager could be found [here](https://github.com/dotnet/m

#### 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)
Copy link

Copilot AI Nov 11, 2025

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).

Suggested change
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)

Copilot uses AI. Check for mistakes.
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)).
Copy link

Copilot AI Nov 11, 2025

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.

Suggested change
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).

Copilot uses AI. Check for mistakes.


#### Example of consuming the CustomConfigurationData
Expand Down