Skip to content

Conversation

@davidjenni
Copy link
Contributor

Description

Update CLI/tool documentation on how to correctly emit /diag information via logfile or stdout.
Also adds an opportunistic test coverage for the /diag switch in the HelpWriterTests suite.

The same .md is used for both CLI and the documentation web site; caveat emptor to the project owners to not deploy doc updates until the next 6.x milestone release (or hold this PR merge)?

Related Issue

Resolves #4539; covers the follow up CR comment in #4762

Motivation and Context

As discussed in 4539, the agreed approach to "fix" the >= 6.3.0 breaking change behavior for the /diag switch is to document that it is now required to also supply the output stream, e.g. /diag /l console to emit both diagnostic info and JSON into stdout

How Has This Been Tested?

dotnet run --project src/GitVersion.App/GitVersion.App.csproj -f net10.0 -- -h

-> updated help texts do show up

Screenshots (if appropriate):

image

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@sonarqubecloud
Copy link

@arturcic arturcic requested a review from asbjornu November 26, 2025 21:46
Copy link
Member

@arturcic arturcic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@arturcic arturcic merged commit bf30883 into GitTools:main Nov 27, 2025
122 checks passed
@mergify
Copy link
Contributor

mergify bot commented Nov 27, 2025

Thank you @davidjenni for your contribution!

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.

[ISSUE]: 6.3.0 diag flag not working

2 participants