-
-
Notifications
You must be signed in to change notification settings - Fork 106
Fix documentation to use --treenode-filter instead of unsupported --filter syntax #4020
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
Conversation
Co-authored-by: thomhurst <[email protected]>
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 fixes critical documentation errors where TUnit-specific CLI syntax was incorrectly shown using VSTest's --filter option, which TUnit does not support. The changes replace incorrect filter syntax with TUnit's --treenode-filter option across CI/CD examples.
- Updated all examples from
--filter "Category=X"to correct-- --treenode-filter "/*/*/*/*[Category=X]"syntax - Added helpful notes about .NET 10 SDK's simplified syntax (
--treenode-filter "/**[Category=X]") that doesn't require the--separator - Ensures users can successfully filter tests by category in CI/CD pipelines
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/docs/examples/tunit-ci-pipeline.md |
Fixed GitLab CI and GitHub Actions examples to use correct --treenode-filter syntax; added .NET 10 SDK note |
docs/docs/advanced/performance-best-practices.md |
Fixed CI/CD optimization examples to use correct --treenode-filter syntax; added .NET 10 SDK note |
Please check the following before creating a Pull Request
Description
TUnit doesn't support VSTest's
--filterCLI option. Documentation incorrectly showed using--filter "Category=X"which results in "Unknown option '--filter'" errors.Changes
CI/CD Pipeline Documentation (
docs/docs/examples/tunit-ci-pipeline.md)Performance Best Practices (
docs/docs/advanced/performance-best-practices.md)Syntax
Incorrect (VSTest):
Correct (TUnit):
Both
dotnet runanddotnet testsupport the tree-node filter syntax with the--separator (not needed in .NET 10+).Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.