Improve config provider logs #4496
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates logging messages for configuration file loading to provide more clarity and consistency. Now it logs when: - Default configuration is used - Configuration file is not found - Configuration file is being used
There was a problem hiding this comment.
Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.
Files not reviewed (1)
- src/GitVersion.sln: Language not supported
Comments suppressed due to low confidence (2)
src/GitVersion.Configuration/ConfigurationProvider.cs:80
- [nitpick] While logging that no configuration file was provided is useful, consider adding a brief comment or documentation to clarify why a null path is treated as a valid case rather than an error so that maintainers understand the decision-making.
this.log.Info("No configuration file found, using default configuration")
src/GitVersion.Configuration/ConfigurationProvider.cs:86
- [nitpick] The log message for a non-existent file differs from the one for a null configuration path; consider aligning these messages or adding documentation to explain the distinct behaviors for improved clarity during troubleshooting.
this.log.Info($"Configuration file '{configFilePath}' not found")
asbjornu
approved these changes
Apr 15, 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several changes to the logging and configuration handling in the
GitVersionproject. The most important changes involve updating log messages for configuration file handling, adding logging functionality, and correcting file references.Updates to log messages:
src/GitVersion.Configuration.Tests/Configuration/ConfigurationFileLocatorTests.cs: Updated log message expectations inNoWarnOnCustomYmlFileandNoWarnOnCustomYmlFileOutsideRepoPathto match "No configuration file found, using default configuration". [1] [2]src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs: Updated log message expectation inNoWarnOnGitVersionYmlFileto match "Using configuration file '{filePath}'".Addition of logging functionality:
src/GitVersion.Configuration/ConfigurationFileLocator.cs: Added log message for found configuration file inVerifymethod.src/GitVersion.Configuration/ConfigurationProvider.cs: AddedILogdependency and corresponding log messages for configuration file handling. [1] [2] [3]Correction of file references:
src/GitVersion.sln: Corrected the reference to.gitversion.ymlin the solution file.