Skip to content

docs: correct .netconfig keys in MSBuild example - #789

Merged
danielpalme merged 1 commit into
danielpalme:mainfrom
dajiaohuang:docs/msbuild-netconfig-keys-20261016
Oct 16, 2026
Merged

danielpalme merged 1 commit into
danielpalme:mainfrom
dajiaohuang:docs/msbuild-netconfig-keys-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown
Contributor

Summary

Correct the three configuration keys in the README's MSBuild .netconfig example to match DotNetConfigSettingNames and the MSBuild task: targetdir, historydir, and verbosity.

Following the current example while omitting the task's TargetDirectory parameter fails with TargetDirectory is required. The other two keys are also ignored, so the documented history and verbosity settings are not applied.

Validation

  • Invoked the real MSBuild task against a small synthetic Cobertura report, with no custom plugins: original example exits 1 with TargetDirectory is required.
  • With only the three documented keys corrected, the same task exits 0 and generates HTML, LaTeX, and a persistent history file with verbose output.
  • git diff --check passes.

Documentation-only change. Tested on Windows with .NET SDK 10.0.100; the repository-declared SDK 10.0.401 and the full test suite were not run.

@danielpalme
danielpalme merged commit ae68e8d into danielpalme:main Oct 16, 2026
4 checks passed
@danielpalme

Copy link
Copy Markdown
Owner

Thank you!

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.

2 participants