Skip to content

docs: fix position of --results-directory in documentation#5038

Merged
thomhurst merged 1 commit intothomhurst:mainfrom
vbreuss:fix-results-directory-documentation
Mar 1, 2026
Merged

docs: fix position of --results-directory in documentation#5038
thomhurst merged 1 commit intothomhurst:mainfrom
vbreuss:fix-results-directory-documentation

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Mar 1, 2026

Description

I finally got the CI-Build in Mockolate to work with TUnit. The problem was, that the --results-directory is no custom CLI argument, but has to be specified before the -- separator.

This PR updates the documentation accordingly!

Related Issue

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Performance improvement
  • Refactoring (no functional changes)

Checklist

Required

  • I have read the Contributing Guidelines
  • If this is a new feature, I started a discussion first and received agreement
  • My code follows the project's code style (modern C# syntax, proper naming conventions)
  • I have written tests that prove my fix is effective or my feature works

TUnit-Specific Requirements

  • Dual-Mode Implementation: If this change affects test discovery/execution, I have implemented it in BOTH:
    • Source Generator path (TUnit.Core.SourceGenerator)
    • Reflection path (TUnit.Engine)
  • Snapshot Tests: If I changed source generator output or public APIs:
    • I ran TUnit.Core.SourceGenerator.Tests and/or TUnit.PublicAPI tests
    • I reviewed the .received.txt files and accepted them as .verified.txt
    • I committed the updated .verified.txt files
  • Performance: If this change affects hot paths (test discovery, execution, assertions):
    • I minimized allocations and avoided LINQ in hot paths
    • I cached reflection results where appropriate
  • AOT Compatibility: If this change uses reflection:
    • I added appropriate [DynamicallyAccessedMembers] annotations
    • I verified the change works with dotnet publish -p:PublishAot=true

Testing

  • All existing tests pass (dotnet test)
  • I have added tests that cover my changes
  • I have tested both source-generated and reflection modes (if applicable)

Additional Notes

I finally got the [CI-Build in Mockolate](aweXpect/Mockolate#223) to work with TUnit. The problem was, that the `--results-directory` is no custom CLI argument, but has to be specified before the `--` separator.
*Even though the error message is very misleading :(*
@thomhurst
Copy link
Owner

Thanks!

@thomhurst thomhurst merged commit 04ee449 into thomhurst:main Mar 1, 2026
2 checks passed
This was referenced Mar 2, 2026
This was referenced Mar 2, 2026
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.

[Bug]: Documented workflow does not work in GitHub Actions

2 participants