Skip to content

Updates help writer to include all arguments #4562

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

Merged
merged 1 commit into from
May 31, 2025

Conversation

arturcic
Copy link
Member

Updates the help writer tests to verify that all arguments are present in the help output. This ensures that users have access to comprehensive information about available command-line options.

Updates the help writer tests to verify that all arguments are present in the help output. This ensures that users have access to comprehensive information about available command-line options.
@arturcic arturcic marked this pull request as ready for review May 31, 2025 20:45
@Copilot Copilot AI review requested due to automatic review settings May 31, 2025 20:45
Copy link

@Copilot Copilot AI left a 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 reorders and restores the UpdateWixVersionFile flag in the Arguments class and expands the help‐writer tests to verify that every CLI argument is included in the generated help output.

  • Reintroduce and relocate UpdateWixVersionFile in Arguments.cs
  • Extend HelpWriterTests with mappings for all existing and new arguments
  • Ensure no argument flags are omitted from the help output

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/GitVersion.App/Arguments.cs Moved UpdateWixVersionFile into the update-options group
src/GitVersion.App.Tests/HelpWriterTests.cs Added missing switches for new flags and reorganized mappings
Comments suppressed due to low confidence (1)

src/GitVersion.App.Tests/HelpWriterTests.cs:21

  • [nitpick] The dictionary of argument switches is unsorted, which can make future updates error-prone. Consider sorting entries alphabetically by key or grouping related flags to improve readability and maintainability.
var lookup = new Dictionary<string, string>

@arturcic arturcic added this to the 6.x milestone May 31, 2025
@arturcic arturcic merged commit 2855256 into GitTools:main May 31, 2025
93 checks passed
@arturcic arturcic deleted the fix/improve-help branch May 31, 2025 21:39
Copy link
Contributor

mergify bot commented May 31, 2025

Thank you @arturcic for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant